Newts

Helping newcomers find services perfect for them!

Getting the DB setup

Before starting the database, clone the .env.sample file in /backend and replace POSTGRES_PASSWORD with your choice of password. You also must have Docker running on your device. To get the database setup, run the following commands:

cd backend
docker-compose up -d

The database should now be running at localhost:5332, based on how this is configured for your machine.

Next, install dbmate. To create new migrations, run

dbmate new insert_migration_name

and update the file created in /backend/db/migrations. Once finished updating this file, run

dbmate up

to apply the migrations.

Starting the backend

To start the backend, you must have Python 3.9 installed. Start a virtual environment if desired:

python -m venv env
./env/Scripts/activate

and install all dependencies to start the project:

pip install -r requirements.txt
python app.py

and you should have the backend running!

Starting the frontend

To start the frontend, you must have Node installed. Navigate to the frontend fold and install all dependencies:

npm run install

and start up the frontend on localhost:

npm run dev