Skip to content

Guide to setup the project locally #1546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+29 −0
Open

Guide to setup the project locally #1546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).