Forward App

Useful Links

• Client/Frontend Notes
• API Documentation
• Database Documentation

Production

The nessecary .env.production files needed for a full scale production deployment are found on the backend server.

On the backend server, to run the correct docker compose, please run the command:

docker-compose -f compose.production.yaml down && docker-compose -f compose.production.yaml up

This should use the correct env files if the repo is cloned within the default user's home directory.

Important

DO NOT run the development server with the default docker-compose up as this will source an insecure environment file, as well as run development-only scripts that may destroy user data. It will also not be exposed correctly through https, and requests to it will not be protected with SSL.

Development

Docker

If you have Docker installed on your system, a system agnostic testing environment is available by running docker compose up

This docker container will automatically run a development build of the full-scale app that will live update with changes. ^C (Ctrl-C) to exit the container.

Note

Any data action taken within the context of the container, such as user registration / lesson progress, will reflect in your host system, this is due to the fact the folders are being mounted to the container for hot-reloading.

---

Frontend

npm run dev This will start the Frontend dev server, making it available at http://localhost:5173/

---

Backend

1. Setup development environment. This will:
   1. Create and activate a virtual environment
   2. Intall dependencies (via pip)
   3. Run database migrations
   4. Seed the database with test data

cd Forward-server
./setup_dev.sh

Note: This only works for windows machines. If you are running MacOS or Linux you replace must this line in setup_dev.sh:

./.venv/Scripts/activate # For windows only

with:

source .venv/bin/activate

4. Run the development server

python manage.py runserver

The server will be running at http://localhost:8000