OpenSource CMS, a simplistic retro CMS, aimed for the Retro community free of charge. Check out the roadmap!

First clone the repository. Once cloned we have to prepare two environments.

1. Backend
2. Frontend

Assuming python is installed (3.9.13 or higher). Setup a virtual environment

python -m venv venv

Activate your environment

Install the requirements in your activated environment

pip install -r requirements.txt

In visual studio code, you can hit F5 with the development environment RUN: Webserver selected. Outside visual studio code, you have to set the environment variable FLASK_APP pointing to the webserver.py file.

Windows

set FLASK_APP=webserver

Unix

export FLASK_APP=webserver

Then continue

flask run

All commands from this point on are executed inside the frontend folder

cd frontend

Make sure the frontend requirements are installed.

npm install

The frontend can be enabled with hot-reload for easy development, for a production build we use the command

npm run build

This build gets served by Flask.

For hot-reload run the next command along side the backend

npm run watch

!Important: For hot-reload to work properly; First run the frontend followed by the backend

If everything runs correctly, the following links should be available

• Frontend
• RapiDocs
• Redocly
• Swagger

For this to work correctly, you are required to make a .env file in the root of this repository. You can use the following .env file as example:

DB_USERNAME=root
DB_PASSWORD=SuperSecretPass123
DB_HOST=127.0.0.1
DB_PORT=3888
DB_SCHEMA=retro

EMULATOR_HOST=http://127.0.0.1:81

WARNING: IN THE CURRENT STATUE OF THIS APPLICATION, DO NOT USE THIS ON AN EXISTING DATABASE, ONLY FRESH RETROS

Passwords are encrypted with this CMS, existing passwords will be overwritten and users will lose access to their account. Wait until migration tooling exist or start a fresh retro.

In a terminal where set FLASK_APP=webserver.py has been activated run;

flask db upgrade

which applies the required database tables and upgrades for the CMS to work