best-hackathon-test

This portal facilitates the process of providing assistance to people in need, making it easier to connect those who provide help.

Connect with kindness: Post your help requests and lend a hand to those in need.

Documentation

All the documentation is available on the http://localhost:8000/docs

Run flake8 before pushing

flake8

Note For full functionality, you need to provide all variables in .env

See example in .env_example

Clone the repository:

git clone https://github.com/dkostmii/best-hackathon-test

Change to the project's directory:
```
cd best-hackathon-test
```
Once you're in the desired directory, run the following command to create a virtual environment:
```
python -m venv venv
```
Activate the virtual environment:

On macOS and Linux:
```
source venv/bin/activate
```
On Windows:
```
venv\Scripts\activate
```
Install the dependencies localy
```
pip install -r requirements.txt
```
Create a .env file in the root of the project and add the variables, same as in .env_example file.

Run the app

alembic upgrade head &&
python3 -m uvicorn app.main:base_app --host 0.0.0.0 --port 8000 --reload

Prerequesites Docker should be installed.

Models already are accessible in alembic/env.py, thanks to from database import Base statement.
Create a migration:
```
./utils/create_migration.sh migration_message
```
Migration will up automatically after running the app.

To downgrade the migration, run:
```
./utils/downgrade_migration.sh
```