Skip to content

Add basic install instructions #5

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
davidar merged 2 commits into from
Mar 8, 2025
Merged

Add basic install instructions #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b9ac6c
Add basic install instructions
rocky Feb 16, 2025
e2c3a04
Note one-time setup steps vs. server start
rocky Feb 16, 2025
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@ JupyterLite is being tested against modern web browsers:
- Firefox 90+
- Chromium 89+

## Installing and running locally

Install this code in a virtual Python environment:
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```

The above needs to be done only once.

Once the virtual environment has been set up with the packages installed, to run the server:

```bash
make serve
```

## Further Information and Updates

For more info, keep an eye on the JupyterLite documentation:
Expand Down