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

Jump to bottom

Update devs readme #15

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update devs readme #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cdb9e7
mention env variables in readme_devs.md
Dec 7, 2023
10a3c36
readme_devs tweaks
Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions README_DEVS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

Various useful tips for running the API LAB in development mode.

## Setup

Before trying to do any development work, you will need to create a `set-envs.sh` file in the `tools` folder.

The purpose of this file is to define the local directories you would like to use for building test and staging versions of site, to ensure the site renders as expected before pushing to production.

Example directories are given in `tools/set-envs-sample.sh`. Replace the values for the stated variables with those you desire.

Note the `.gitignore` file is set to ignore `set-envs.sh`.

## Workflow

### 1. Adding new notebooks
Expand Down