From 780bba3e632b8ce6aeeae459cd5c783d1e804147 Mon Sep 17 00:00:00 2001 From: mohamedachrefhacheni Date: Wed, 16 Apr 2025 00:08:39 +0100 Subject: [PATCH] guide to setup the project locally --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..28540182c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +Step 1: Clone the Repository: + +git clone https://github.com/your-username/project-name.git +cd project-name + +Step 2: Install Dependencies: + +##(frontend) +npm install +(backend) + +python -m venv env(Create a virtual environment and activate it) +source env/bin/activate +pip install uvicorn. + +(database) + +Install PostgreSQL. + +Set a password for the postgres user. +Make note of the port (default is 5432). +Connect to PostgreSQL Locally. +psql -U postgres. +Create a Database(save the name for .env file). +Update Your App's .env. + +Migrate the database using + + (alembic upgrade head). \ No newline at end of file