Skip to content

Commit

Permalink
Add extra info to README.md
Browse files Browse the repository at this point in the history
Added some information I needed to get started with nectar development.
  • Loading branch information
JCRPaquin authored Oct 31, 2023
1 parent 3cc36d7 commit 492b013
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

#### Dependencies

Install `pnpm` and [the current long term support version of nodejs](https://github.com/nodejs/Release). If you want `pnpm` to manage `node` versions for you, use the standalone installer script.

Install the project dependencies:

```bash
Expand All @@ -12,7 +14,18 @@ pnpm install

#### Development

Start the development server:
Be sure to set the following environment variables prior to starting the development server:
- `COOKIE_SECRET`, should be at least 32 characters long
- `ADS_SESSION_COOKIE_NAME`
- `SCIX_SESSION_COOKIE_NAME`

Then you can start the development server with mock API endpoints:

```bash
pnpm dev:mocks
```

Or, run the development server against live APIs:

```bash
pnpm dev
Expand Down

0 comments on commit 492b013

Please sign in to comment.