-
Fork this repo: click
Fork
in the top-right of the page - this will create a copy of this repo in your own GitHub account -
Clone (download) the repo
- Go to your newly-created fork of the repo (on GitHub).
- Click
Clone or download
(the green button on the right). - Make sure the page says
Clone with SSH
(rather thanClone with HTTPS
). - Open your git client (e.g. GitKraken) and use this link to clone the repo.
Your trainer will able to help you with this.
-
"Cloning the repo" will create a folder on your computer with the files from this repo. Open this folder in Visual Studio Code.
-
Make sure you've got PostgreSQL and pgAdmin installed. You'll need to set up a user and a database for this project. All instructions for this step are in the
Setting up PostgreSQL
section below. -
Open a command-prompt in this same folder. Your trainer can show you how to do this, if you need any help.
-
Run this command to set up the necessary dependencies:
poetry install
-
Run this command to run your code:
poetry run start
-
The app should now be available at https://localhost:5000
Before you run the app you will need to make sure you've got PostgreSQL installed and a database set up.
-
Download and install the PostgreSQL server software if you haven't already.
-
Open the Windows Start menu and search for "pgAdmin". When you start "pgAdmin" for the first time, you'll be asked to set a master password.
-
Inside your PostgreSQL server in pgAdmin, right-click on Login/Group Roles and create a new Login/Group Role with the name
duckduckgoose
(in the General tab), the passwordduckduckgoose
(in the Definition tab) and the ability to log in and create databases (in the Privileges tab). -
Click Save to create the user.
-
Inside your PostgreSQL server in pgAdmin, right-click on Databases and create a new Database with the name
duckduckgoose
and the ownerduckduckgoose
(both in the General tab). -
Click Save to create the database.