https://github.com/chmac/nb-web

A client side web app to view nb notebooks
https://github.com/chmac/nb-web

Last synced: 4 months ago
JSON representation

A client side web app to view nb notebooks

• Host: GitHub
• URL: https://github.com/chmac/nb-web
• Owner: chmac
• License: agpl-3.0
• Created: 2021-07-15T09:54:13.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-12-22T19:12:29.000Z (over 4 years ago)
• Last Synced: 2025-09-05T08:38:32.754Z (9 months ago)
• Language: TypeScript
• Homepage: https://chmac.github.io/nb-web/
• Size: 3.61 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nb-web

A (currently extremely crude and ugly) web based version of

[nb](https://xwmx.github.io/nb/).

- Currently read-only

## Instructions

- To get started, load the app.

- It will ask for a URL via a pop up

  - Enter a valid git URL

  - You probably need to include authentication

  - For example `https://user:pass@host/user/repo.git`

  - The repo must return proper CORS headers

    - Unfortunately this excludes GitHub, GitLab, and some others

    - Gitea can have CORS headers enabled and works great

- Click the clone button, wait for the success alert

- Click the "Load notebook" button to see the notebook

- Click on a note to load it or a folder to navigate to it

Please feel free to file an issue if you hit any problems.

## Development

The code lives in `app/`, it was created with create-react-app, and is in

TypeScript.