Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extra info to README.md #342

Closed
wants to merge 1 commit into from
Closed

Add extra info to README.md #342

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
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
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this requires an API proxy? Is there a command to run before this to ensure the dev frontend can access the backend?

Expand Down
Loading