🇧🇷 BRASA API 🇧🇷

🧑‍💻 UCF BRASA's student created API 🧑‍💻

📖 Prerequisites

Tools/Technologies (required)

• Python@3.11
• Poetry
• MongoDBCompass or MongoDB VSC Extension

VSC Extensions (recommended)

• Black
• Flake8
• isort
• Python Indent
• BetterTOML
• ENV

Environment Variables file (required)

Before running the app, you need to fill out the .env file. Please reach out to either:

• Fachetti (EniGzz#0011)
• Duda (Joazeiro#0815)

🖥️ Local development

Installing

Run the following command to install all the project dependencies.

poetry install

poetry run pre-commit install

Running

poetry run start

The application will be available at https://localhost:8080

📓 Documentation

Swagger Docs

https://brasa-api.up.railway.app/docs

Redoc Docs

https://brasa-api.up.railway.app/redoc

🧪 Test

For running the unit test suite, use the following command:

poetry run pytest

🧰 Built With

• FastAPI - The API framework used
• MongoDB - NoSQL database
• Beanie - Database ODM (Object Document Mapper)
• Poetry - Dependency and virtual environment manager
• Flake8 - Code Linter
• Black - Code Formatter

Deployment

We are using Railway🚅 to deploy our app using uvicorn.

License

This project is licensed under the MIT License - see the LICENSE file for details