Skip to content

Commit

Permalink
update readme to reflect that we only support Node 14
Browse files Browse the repository at this point in the history
  • Loading branch information
rohangpta committed Aug 16, 2023
1 parent 4f306b1 commit 8b9a6aa
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Official React-based website for Penn Labs' club directory and events listings.
The REST API written in Django for Penn Clubs infrastructure.

## Installation

You will need to start both the backend and the frontend to do Penn Clubs development.

Questions? Check out our [extended guide](https://github.com/pennlabs/penn-clubs/wiki/Development-Guide#windows-development) for FAQs for both Mac and Windows.
Expand All @@ -16,6 +17,7 @@ Questions? Check out our [extended guide](https://github.com/pennlabs/penn-clubs
Running the backend requires [Python 3](https://www.python.org/downloads/).

In production, you will need to set the following environment variables:

- `NEXT_PUBLIC_SITE_NAME` (optional, defaults to `clubs`)
- `SECRET_KEY`
- `SENTRY_URL`
Expand All @@ -27,6 +29,7 @@ In production, you will need to set the following environment variables:
- `LABS_CLIENT_SECRET` (from Platform)

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

- `cd backend`

Setting up `psycopg2` (this is necessary if you want to be able to modify
Expand All @@ -42,24 +45,29 @@ dependencies, you can revisit later if not)
- Windows
- `$ apt-get install gcc python3-dev libpq-dev`

Now, you can run
Now, you can run

- `$ pipenv install` to install Python dependencies. This may take a few
minutes. Optionally include the `--dev` argument if you are installing locally
for development. If you skipped installing `psycopg2` earlier, you might see
an error with locking -- this is expected!
- `$ pipenv shell`
- `$ pre-commit install`
- `$ pre-commit install`
- `$ ./manage.py migrate` OR `$ python3 manage.py migrate`
- `$ ./manage.py populate` OR `$ python3 manage.py populate` (in development,
to populate the database with dummy data)
- `$ ./manage.py runserver` OR `$ python3 manage.py runserver`

### Frontend

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

**Please ensure you are using Node 14**. Our codebase does not support other
versions of Node (v14.21.3 is stable).

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.
Expand Down

0 comments on commit 8b9a6aa

Please sign in to comment.