Skip to content

Commit

Permalink
Merge pull request #22 from yuvipanda/doc-contr
Browse files Browse the repository at this point in the history
Add additional steps to CONTRIBUTING.md
  • Loading branch information
yuvipanda authored Mar 28, 2024
2 parents 5874628 + 4b506d6 commit 1afb6f3
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,37 @@ but can be adapted to work with any other local kubernetes setup.
python -m pip install -r dev-requirements.txt
```

4. Install [configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy/),
4. Install the `jupyterhub-fancy-profiles` package itself.

```bash
python -m pip install -e .
```

This also will build the JS and CSS assets.

5. Install [configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy/),
as that is required for JupyterHub to run.

```bash
npm install configurable-http-proxy
```

5. Put `configurable-http-proxy` in `$PATH` so jupyterhub can discover it.
6. Put `configurable-http-proxy` in `$PATH` so jupyterhub can discover it.

```bash
export PATH="$(pwd)/node_modules/.bin:${PATH}"
```

6. Now, start `jupyterhub` and go to `localhost:8000` to access it! You can login with any
7. Now, start `jupyterhub` and go to `localhost:8000` to access it! You can login with any
username and password.

```bash
jupyterhub
python -m jupyterhub
```

8. If you're working on the JS / CSS, you can also run the following command in another
terminal to automatically watch and rebuild the JS / CSS as you edit.

```bash
npm run webpack:watch
```

0 comments on commit 1afb6f3

Please sign in to comment.