Skip to content

Commit

Permalink
Explain submission deadline env var in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Pabl0cks committed Sep 3, 2024
1 parent 2185b28 commit b0c492f
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,26 @@ Before you begin, you need to install the following tools:

## Development Quickstart

1. Install dependencies
### 0. Set up environment variables

For local development, in your `.env.local` add the following:

```
NEXT_PUBLIC_SUBMISSION_DEADLINE=YYYY-MM-DDTHH:MM:SS
```

Replace `YYYY-MM-DDTHH:MM:SS` with the actual deadline (e.g., "2024-03-31T23:59:59", deadline must be in UTC).
This variable controls the visibility of the apply button and form submissions.

> Note: For a PROD environment, you can set the deadline in the .env file or set the environment variable in your hosting provider.
### 1. Install dependencies

```
yarn install
```

2. Spin up the Postgres database service + create database + seed
### 2. Spin up the Postgres database service + create database + seed

```
docker-compose up -d
Expand All @@ -27,7 +40,7 @@ yarn seed

See more info about the database in the section below

3. Start your NextJS app:
### 3. Start your NextJS app:

```
yarn start
Expand Down

0 comments on commit b0c492f

Please sign in to comment.