{"id":16284541,"url":"https://github.com/derthorsten/litesaber","last_synced_at":"2025-04-09T00:05:46.918Z","repository":{"id":146947184,"uuid":"491010408","full_name":"DerThorsten/litesaber","owner":"DerThorsten","description":"litesaber","archived":false,"fork":false,"pushed_at":"2022-05-11T15:12:26.000Z","size":208,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-14T18:49:07.625Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DerThorsten.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-11T07:53:10.000Z","updated_at":"2022-05-11T07:53:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"7e55c5c6-e600-4884-8757-cc678c2ffcd7","html_url":"https://github.com/DerThorsten/litesaber","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"jtpio/jupyterlite-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerThorsten%2Flitesaber","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerThorsten%2Flitesaber/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerThorsten%2Flitesaber/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerThorsten%2Flitesaber/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DerThorsten","download_url":"https://codeload.github.com/DerThorsten/litesaber/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247947859,"owners_count":21023066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T19:19:53.183Z","updated_at":"2025-04-09T00:05:46.898Z","avatar_url":"https://github.com/DerThorsten.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JupyterLite Demo\n\n[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/demo)\n\nJupyterLite deployed as a static site to GitHub Pages, for demo purposes.\n\n## ✨ Try it in your browser ✨\n\n➡️ **https://jupyterlite.github.io/demo**\n\n![github-pages](https://user-images.githubusercontent.com/591645/120649478-18258400-c47d-11eb-80e5-185e52ff2702.gif)\n\n## Requirements\n\nJupyterLite is being tested against modern web browsers:\n\n- Firefox 90+\n- Chromium 89+\n\n## Usage\n\nThis repository provides a demonstration of how to:\n\n- build a JupyterLite release using prebuilt JupyterLite assets that bundles a collection of pre-existing Jupyter notebooks as part of the distribution;\n- deploy the release to GitHub Pages.\n\nThe process is automated using Github Actions.\n\nYou can use this repository in two main ways:\n\n- generate a new repository from this template repository and build and deploy your own site to the corresponding Github Pages site;\n- build a release from a PR made to this repository and download the release from the created GitHub Actions artifact.\n\n### Co-opting This Repository to Build a Distribution\n\n*Requires Github account.*\n\nTo use this repository to build your own release:\n\n- create a fork of this repository by clicking on one of the files (such as [`requirements.txt`](https://github.com/jupyterlite/demo/blob/main/requirements.txt) and then click on the *edit* button to create your own fork of the repository;\n- update the `requirements.txt` file as required (or just cancel the edit if you were simply forking the original repository);\n- remove unwanted notebooks from the `contents` directory;\n- upload your own notebooks intended for release to that directory;\n- from the *Pull Requests* tab of your Github repository, make a pull request of the changes you made back to the main `jupyterlite-demo` repository.\n\n![](https://user-images.githubusercontent.com/82988/132512423-ac5609b7-3e8e-4ea9-80ba-ddb08c9ffebb.png)\n\nThe PR will trigger a build on the repository. Go to the [Actions tab](https://github.com/jupyterlite/demo/actions) and find the build triggered by your pull request. When the build has completed, the release will be available as a generated asset.\n\n![](https://user-images.githubusercontent.com/82988/132511258-aff31973-d7e2-4e39-89d5-3feb0ced139b.png)\n\nDownload the distribution/generated asset and unzip it, for example into a directory of the form `jupyterlite-demo dist 46`. The directory contains your JupyterLite distribution. To run the distribution via a web browser, it needs to be served by a web server.\n\nIf you have Python installed, on the command line change directory into the the unzipped distribution folder and run the command: `python -m http.server`. This will launch a web server from the directory, for example on port 8000. View the website in your browser (for example, at the web location `http://localhost:8000`).\n\n### Using Your Own Repository to Build a Release and Deploy it to Github Pages\n\n*Requires Github account.*\n\nClick on \"Use this template\" to generate a repository of your own from this template:\n\n![template](https://user-images.githubusercontent.com/21197331/125816904-5768008a-77de-4cb3-8013-f3999b135c02.gif)\n\nFrom the [*Actions*](./actions) tab on your repository, ensure that workflows are enabled. When you make a commit to the `main` branch, a Github Action will run to build your JupoyterLite release and deploy it to the repository's Github Pages site. By default, the Github Pages site will be found at `YOUR_GITHUB_USERNAME.github.io/YOUR_REPOSITORY-NAME`. *You can also check the URL from the Repository `Settings` tab `Pages` menu item.*\n\n__Add any additional requirements as required to the `requirements.txt` file.__\n\n*You can do this via the Github website by selecting the `requirements.txt` file, clicking to edit it, making the required changes then saving (\"committing\") the result to the `main` branch of your repository.*\n\n__Modify the contents of the `contents` folder to include the notebooks you want to distribute as part of your distribution.__\n\n*You can do this by clicking on the `contents` directory and dragging notebooks from your desktop onto the contents listing. Wait for the files to be uploaded and then save them (\"commit\" them) to the `main` branch of the repository.*\n\nCheck that you have Github Pages enabled for your repository: from your repository [*Settings*](./settings) tab, select the [*Pages*](./settings/pages) menu item and ensure that the source is set to `gh-pages`.\n\nWhen you commit a file, an updated release will be built and published on the Github Pages site. Note that it may take a few minutes for the Github Pages site to be updated. Do a hard refresh on your Github Pages site in your web browser to see the new release.\n\n\n\n### Further Information and Updates\n\nFor more info, keep an eye on the JupyterLite documentation:\n\n- Configuring: https://jupyterlite.readthedocs.io/en/latest/configuring.html\n- Deploying: https://jupyterlite.readthedocs.io/en/latest/deploying.html\n\n### Deploy a new version of JupyterLite\n\nTo change the version of the prebuilt JupyterLite assets, update the `jupyterlite` package version in the [requirements.txt](./blob/main/requirements.txt) file.\n\nThe `requirements.txt` file can also be used to add extra prebuilt (\"federated\") JupyterLab extensions to the deployed JupyterLite website.\n\nCommit and push any changes. The site will be deployed on the next push to the `main` branch.\n\n## Development\n\nCreate a new environment:\n\n```bash\nmamba create -n jupyterlite-demo\nconda activate jupyterlite-demo\npip install -r requirements.txt\n```\n\nThen follow the steps documented in the [Configuring](https://jupyterlite.readthedocs.io/en/latest/configuring.html) section.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderthorsten%2Flitesaber","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderthorsten%2Flitesaber","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderthorsten%2Flitesaber/lists"}