API Documentation

The API is documented using Swagger UI. You can access the API documentation at /api-docs endpoint.

How to Run

1. Clone this repository.
2. Make sure you have python3 and node installed in your system
3. Set the environments variables as described below.
4. Copy and fill the necessary env variables from .env.example file to .env.
5. Install dependencies using npm install && pip install -r requirement.txt.
6. Start the server using npm run dev.

Docker

If you want to use docker:

1. Make sure to set the environment variables correctly from .env.example to .env, more details here
2. Run these commands in this order

chmod +x build-docker.sh run-docker.sh
./build-docker.sh
./run-docker.sh

Environment Variables

Make sure to set the following environment variables:

• MONGO_URI: MongoDB database connection URI. Example: mongodb+srv://?:?@cluster0.cxl50.mongodb.net/?retryWrites=true&w=majority&appName=Cluster0
• PORT: Port number for the backend server (default is 3000).
• ORIGIN_PORT: Port number for the frontend server (default is 4000).
• SESSION_SECRET: Secret key for session management. Example: thisisasessionsecret
• SENDER_EMAIL: The email of the sender 'which is the email of the one created the SMTP server'.
• REPLY_TO: Email listed to reply with when user want to do reply!
• SMTP_PORT: The port of the SMTP server. Example: 465
• SMTP_USER: The user of the SMTP server.
• SMTP_PASS: The password of the SMTP server.
• SMTP_HOST: The SMTP server host. Example: smtp.gmail.com
• ADMIN_EMAIL: The email of the admin. Example: admin@admin.com

License

This project is licensed under the MIT License.