Running

On this page, the steps for running the application correctly are reported.

Prerequisites

Make sure you have installed all the required dependencies following the Installation Guide.

Front-end

Once the front end is set up, you can run the development server using the following commands:

cd <PATH_TO_TEACHME>/ui # change directory to the front-end one
npm run dev

You can now open http://localhost:3000/ with your browser to see the result.

Back-end

To run the backend application use the following commands in a new terminal window:

NOTE: if you created a python virtual environment for installing the dependencies, remember to activate it before running the commands!

cd <PATH_TO_TEACHME>/backend # change directory to the back-end one
python3 main.py

Using Docker

If you installed the project using Docker/docker-compose, you can run both the frontend and backend with a single command:

cd <PATH_TO_TEACHME>
docker-compose up

If you want to shutdown the container, use:

docker-compose down

Now you can visit the application at localhost:3000.