Skip to content

Commit

Permalink
updates readme to include .env instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
anudaweerasinghe committed Oct 26, 2023
1 parent 7364c26 commit bc2bbec
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +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.
To get started, run `npm install` in the root, `frontend` and `backend` directories.

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.
Expand All @@ -27,6 +27,14 @@ Run `doppler setup` in the parent folder to set this up.

To run the frontend in development mode:

Create a `.env` file in the `frontend` directory using `.env.template` as a template. You can do this by running

```shell
cp .env.template frontend/.env
```

Then run the following to start the frontend.

```shell
cd frontend
npm run dev
Expand Down

0 comments on commit bc2bbec

Please sign in to comment.