Make sure Docker and Docker Compose are installed on your machine before running the project. You can find installation instructions for Docker Compose here.
To build the images and start the containers needed to run the project:
make
Once the containers are running, you can access the web application at http://localhost:8000.
To stop the application:
make stop
For more information:
make help
Once the project is running, you can find the API documentation at the following endpoint:
/api
The project requires a .env
file at the root of the project to run properly.
This file should be kept secret and not shared publicly.
The format of the required .env
can be found here: example.env
For information on how to use the chat through websockets, refer to chat-ws.md.