This is a monorepo composed of three packages.
- Web (Front End)
- API (Back End)
- Database
To run the application, you will need to open 3 terminal instances and run each of these steps in a separate terminal.
The database runs inside a Docker container.
- You will need to install Docker
- Ensure it is running on your computer to run the database.
- Run the following commands
cd database
npm run start
- Inside the /api directory, duplicate the
.env.example
file and rename the copy to.env
. - Run these commands
cd api
npm install
npm run start
- Run these commands
cd web
npm install
npm run start
If you visit http://localhost:3000
in your browser, you should see a blob of JSON that is being fetched from the database, via the api, and rendered on the front end. 👍