/BRASA-API

🇧🇷 UCF BRASA API - Created with FastAPI by the UCF BRASA Tech Team

Primary LanguagePythonMIT LicenseMIT


Open Sauced

🇧🇷 BRASA API 🇧🇷

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

📖 Prerequisites

Tools/Technologies (required)

VSC Extensions (recommended)

Environment Variables file (required)

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

🖥️ 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