Contribution guildelines

👈🏻 Thanks for visiting this page and your interest in contributing to this repository.

First clone the repository.

git clone https://github.com/asifrahaman13/potential-fiesta.git

Backend

Move to the backend directory

cd potential-fiesta/

You can create vitual environment using poetry shell. It is not madnatory but recommended.

poetry config virtualenvs.in-project true

poetry shell

Create the .env file and give the necessary API Keys.

cp .env.example .env

Now install the necessary dependencies and packages.

poetry install

Make sure you have black and pre-commit hook installed.

poetry add pre-commit
pre-commit install

Now run the backend

poetry run vicorn src.main:app --reload

Open another terminal to move to the front end.

cd frontend/

Install the required packages

bun install

Next run the development server

bun run dev

The best way to utilize the docker is through the docker compose file.

docker compose up -d