Skip to content

docs: Document the usage and requirement for env.js to config dev #163

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

Merged
berkes merged 1 commit into from
Jan 9, 2026
Merged

docs: Document the usage and requirement for env.js to config dev #163

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ node_modules
index.html
src/data/

## Potential secrets
.env
public/env.js
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,27 @@ This will:
## Development on local machine

Alternative to Docker is to run it locally on the machine. This requires yarn
and the right nodejs versions (TODO: what are these?)
and the right nodejs versions (TODO: what are these?).

```
yarn install
```

Before we start the dev server, we should create an env.js file that can be served by the dev server.

Create a file `public/env.js` with content matching your own values. Refer to
`src/util/config.js` for the variables and their defaults.

For example:
```
var SERVER_URL = "http://localhost:8000";
var EXTENSIONS_ROOT_URL = "http://localhost:8000";
var EDU_ID = "https://mijn.test.eduid.nl";
```

Then run the dev server:

```
yarn dev
```

Expand Down