Skip to content

Commit

Permalink
Update README.md with new installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Lhwhatever committed Nov 2, 2023
1 parent 19bd386 commit 3e4687e
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ development, so expect large changes to the codebase and features to be unstable

## Getting Started

To get started, run `npm install` in both the `frontend` and `backend` folders.

Also, we use [Doppler](https://www.doppler.com) to populate the environment with the necessary secrets to access the
database. Follow the instructions [here](https://docs.doppler.com/docs/install-cli) to install the Doppler CLI.
Run `doppler setup` in the parent folder to set this up.
To get started, run `npm install && npm run db-generate` in the root folder, and obtain a copy of the `.env` file. (You can use `.env.template` as a reference.)

### Frontend

Expand Down Expand Up @@ -69,4 +65,4 @@ The Course Tool is built with several technologies.

- The frontend is built using NextJS and React, Redux, Typescript and TailwindCSS.
- The backend uses Express, MongoDB and JS.
- The scrapers are written in JS.
- The scrapers are written in JS.

0 comments on commit 3e4687e

Please sign in to comment.