Skip to content

Commit c7ba8de

Browse files
Deploying JupyterGIS with JupyterLite (#976)
* Deploying JupyterGIS with JupyterLite * Update README with collaboration note for JupyterLite Added a note about collaboration support in JupyterLite. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Revise README for Lite deployment instructions Updated README to include data and jGIS files instructions. * lint --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent ccd93ac commit c7ba8de

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

python/jupytergis/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,28 @@ docker run -p 8888:8888 ghcr.io/geojupyter/jupytergis:latest
6363
Replace `latest` with a specific version number if you prefer.
6464
Docker build source is at <https://github.com/geojupyter/jupytergis-docker>.
6565

66+
## Deploying JupyterGIS with JupyterLite
67+
68+
You can run JupyterGIS entirely in the browser using **JupyterLite**.
69+
70+
1. **Create a repository** using the [xeus-lite-demo](https://github.com/jupyterlite/xeus-lite-demo) template.
71+
2. In your fork, edit `environment.yml` and add:
72+
```yaml
73+
- jupytergis-lite
74+
```
75+
3. **Add your data and jGIS files** under the `content/` directory of your repository.
76+
These files will be available directly inside your Lite deployment.
77+
4. **Enable GitHub Pages** under _Settings → Pages_ for your repository.
78+
5. Once the build completes, your Lite deployment will be live at:
79+
```
80+
https://<username>.github.io/<repo-name>/
81+
```
82+
83+
This provides a lightweight, fully browser-based JupyterGIS environment — no server required.
84+
85+
> [!IMPORTANT]
86+
> Collaboration is **not yet supported** in JupyterLite static deployments.
87+
6688
## Documentation
6789

6890
https://jupytergis.readthedocs.io

0 commit comments

Comments
 (0)