Arquimedia Backend

Arquimedia's new backend using Fastapi.

Installation

This project is optimized to run on a docker container. To run it, you need to have docker and docker-compose installed.

Docker

To install docker, follow the instructions on the official website.

Docker Compose

To install docker-compose, follow the instructions on the official website.

Building

To build the project, you need to run the following command:

make build

This will build the docker image.

Running

To run the project, you need to run the following command:

make deploy

This will run the docker container. The application will be available on the following url:

http://localhost:8001

Stopping

To stop the project, you need to run the following command:

make clean

This will stop the docker container.

Logs (Debugging)

To access the logs, you need to run the following command:

make logs

This will show the logs of the docker container.

Testing

To test the project, you need to run the following command:

make test

This will run pytest on the project.

Documentation

To access the documentation, you need to run the project and access the following url:

http://localhost:8001/docs

Contributing

If not part of the Arquimedia team, you can contribute by following the steps below.

1. Fork the project
2. Create a new branch
3. Make your changes
4. Commit your changes
5. Push your changes
6. Open a pull request
7. Wait for the pull request to be merged
8. Delete your branch
9. Pull the changes from the main branch
10. Repeat from step 3
11. Profit