Skip to content

Commit

Permalink
📝 Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joyliu-q committed Oct 23, 2022
1 parent 045efc5 commit afbdb82
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You will need to start both the backend and the frontend to do Platform developm

Running the backend requires [Python 3](https://www.python.org/downloads/).

To run the server, `cd` to the folder where you cloned `penn-clubs`. Then run:
To run the server, `cd` to the folder where you cloned `platform`. Then run:
- `cd backend`

Setting up `psycopg2` (this is necessary if you want to be able to modify
Expand Down Expand Up @@ -67,11 +67,6 @@ Now, you can run

Running the frontend requires [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/getting-started/install).

You will need to set the following environment variables on the frontend:
- `NEXT_PUBLIC_GOOGLE_API_KEY`
- `NEXT_PUBLIC_SITE_NAME` (Optional)
- Specify `clubs` to show Penn Clubs and `fyh` to show Hub@Penn.

1. Enter the `frontend` directory with a **new terminal window**. Don't kill your backend server!
2. Install dependencies using `yarn install` in the project directory.
3. Run application using `yarn dev`.
Expand Down

0 comments on commit afbdb82

Please sign in to comment.