README.md

Guidio Backend repository

---

This repository contains FastAPI backend and communication with database.

How to run

---

Run within poetry environment

Dependencies:

• Python 3.11
• PostgreSQL
• Poetry - add to path after install
• Optional - PgAdmin

1. Open terminal and navigate to desired project location
2. To clone the repository, run one of following commands:
   • ssh (preferred if you have set up an ssh key): git clone [email protected]:guidioproject/Guidio-Backend.git
   • https: git clone https://github.com/guidioproject/Guidio-Backend.git
   • GitHub CLI: gh repo clone guidioproject/Guidio-Backend
3. Open project in desired code editor and run poetry install
4. After installation process is finished, run poetry shell
5. Create database through terminal or pgAdmin - example
6. Create .env file in root of the project.
7. Copy and paste contents from .env.example and replace # with proper values
   • Keep in mind that for development purposes, you must put the dev value under ENVIRONMENT variable
8. To run the project, run the following command: poetry run guidio
9. Access SwaggerUI using: http://127.0.0.1:8000/docs

Run using docker

1. Make sure you have docker installed and running
2. Open terminal and navigate to desired project location
3. To clone the repository, run one of following commands:
   • ssh (preferred): git clone [email protected]:guidioproject/Guidio-Backend.git
   • https: git clone https://github.com/guidioproject/Guidio-Backend.git
   • GitHub CLI: gh repo clone guidioproject/Guidio-Backend
4. Open the project in desired code editor and create .env file in root of the project.
5. Copy and paste contents from .env.example and replace # with proper values
   • Keep in mind that for development purposes, you must put the dev value under ENVIRONMENT variable
6. To run the project you must be in the root location and run docker-compose up -d
7. Access SwaggerUI using: http://127.0.0.1:8000/docs