Commit 34e2669

committed

update elixir ecosystem

1 parent 9369bc5 commit 34e2669Copy full SHA for 34e2669

File tree

2 files changed

+67

-263

lines changed

README.md
jupyterlab/staging/assets
- elixir-ecosystem-v2.svg

2 files changed

+67

-263

lines changed

`‎README.md‎`

Lines changed: 2 additions & 101 deletions

Original file line number	Diff line number	Diff line change
`@@ -15,49 +15,13 @@`
`15`	`15`	`[![Crowdin](https://badges.crowdin.net/jupyterlab/localized.svg)](https://crowdin.com/project/jupyterlab)`
`16`	`16`	`[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/jupyterlab/jupyterlab/issues)`
`17`	`17`
`18`		`-An extensible environment for interactive and reproducible computing, based on the`
`19`		`-Jupyter Notebook and Ecosystem.`
	`18`	`+[ElixirNote](https://github.com/ElixirNote/elixirnote/tags) is a next-generation web-based user interface for`
	`19`	`+Project Jupyter. The Commercial product such as [Hex](https://hex.tech/), [Deepnote](https://deepnote.com/) ... are also good choices.`
`20`	`20`
`21`	`21`	`![ecosystem](/jupyterlab/staging/assets/elixir-ecosystem-v2.svg)`
`22`	`22`
`23`		`-[ElixirNote](https://github.com/ElixirNote/elixirnote/tags) is the next-generation user interface for [Project Jupyter](https://jupyter.org) offering`
`24`		`-all the familiar building blocks of the classic Jupyter Notebook (notebook,`
`25`		`-terminal, text editor, file browser, rich outputs, etc.) in a flexible and`
`26`		`-powerful user interface. However, [JupyterLab](http://jupyterlab.readthedocs.io/en/stable/) is also a good choice.`
`27`		`-ElixirNote will eventually replace the classic Jupyter Notebook.`
`28`		`-`
`29`		`-ElixirNote can be extended using [npm](https://www.npmjs.com/) packages`
`30`		`-that use our public APIs. The _prebuilt_ extensions can be distributed`
`31`		`-via [PyPI](https://pypi.org/search/?q=jupyterlab&o=-created&c=Framework+%3A%3A+Jupyter),`
`32`		`-conda, and other package managers. The _source_ extensions can be installed`
`33`		`-directly from npm (search for [jupyterlab-extension](https://www.npmjs.com/search?q=keywords:jupyterlab-extension)) but require additional build step.`
`34`		`-You can also find ElixirNote extensions exploring topic [jupyterlab-extension](https://ciusji.gitbook.io/elixirnote/guides/extensions).`
`35`		`-To learn more about extensions, see the [user documentation](https://ciusji.gitbook.io/elixirnote/guides/extensions).`
`36`		`-`
`37`		`-The current ElixirNote releases are suitable for general`
`38`		`-usage, and the extension APIs will continue to`
`39`		`-evolve for ElixirNote extension developers.`
`40`		`-`
`41`	`23`	`Read the current ElixirNote documentation on [ElixirNote Docs](https://ciusji.gitbook.io/elixirnote/).`
`42`	`24`
`43`		`-## Screenshot & Gifs`
`44`		`-`
`45`		`-### Workspace Overview`
`46`		`-`
`47`		`-![overview-1](/jupyterlab/staging/assets/overview-1.png)`
`48`		`-`
`49`		`-### Example Explore`
`50`		`-`
`51`		`-![overview-2](/jupyterlab/staging/assets/overview-2.png)`
`52`		`-`
`53`		`-### Data Viz`
`54`		`-`
`55`		`-![overview-3](/jupyterlab/staging/assets/overview-3.png)`
`56`		`-`
`57`		`-### Notebook Preview`
`58`		`-`
`59`		`-![overview-3](/jupyterlab/staging/assets/overview-4.png)`
`60`		`-`
`61`	`25`	`## Main Features`
`62`	`26`
`63`	`27`	`- A new way to notebook`
`@@ -78,63 +42,6 @@ Read the current ElixirNote documentation on [ElixirNote Docs](https://ciusji.gi`
`78`	`42`	`- HIPAA compliant, and BAA friendly`
`79`	`43`	`- SSO support through Google, Okta, Keycloak, and more`
`80`	`44`
`81`		`-## Getting Started`
`82`		`-`
`83`		`-### Installation`
`84`		`-`
`85`		`-Project installation instructions from the git sources are available in the [contributor documentation](CONTRIBUTING.md).`
`86`		`-`
`87`		`-### pip`
`88`		`-`
`89`		-If you use `pip`, you can install it with:
`90`		`-`
`91`		-```shell
`92`		`-# Clone ElixirServer`
`93`		`-git git@github.com:ElixirNote/elixirserver.git`
`94`		`-cd elixirserver`
`95`		`-pip install -e .`
`96`		`-# Clone ElixirNBC`
`97`		`-git clone git@github.com:ElixirNote/elixirnbc.git`
`98`		`-cd elixirnbc`
`99`		`-pip install -e .`
`100`		`-# Clone ElixirNote`
`101`		`-git clone git@github.com:ElixirNote/elixirnote.git`
`102`		`-cd elixirnote`
`103`		`-pip install -e ".[dev,test]"`
`104`		`-jlpm install`
`105`		`-jlpm run build # Build the dev mode assets (optional)`
`106`		`-jlpm run build:core # Build the core mode assets (optional)`
`107`		`-jupyter lab build # Build the app dir assets (optional)`
`108`		-```
`109`		`-`
`110`		`-### Running`
`111`		`-`
`112`		`-Start up ElixirNote using:`
`113`		`-`
`114`		-```bash
`115`		`-jupyter lab --dev-mode --watch --allow-root --no-browser --ip=0.0.0.0`
`116`		-```
`117`		`-`
`118`		`-If you want load extensions in dev mode:`
`119`		`-`
`120`		-```bash
`121`		`-jupyter lab --dev-mode --watch --allow-root --no-browser --extensions-in-dev-mode --ip=0.0.0.0`
`122`		-```
`123`		`-`
`124`		`-ElixirNote will open automatically in the browser. See the [documentation](https://ciusji.gitbook.io/elixirnote/guides/get-started) for additional details.`
`125`		`-`
`126`		-If you encounter an error like "Command 'jupyter' not found", please make sure `PATH` environment variable is set correctly. Alternatively, you can start up ElixirNote using `~/.local/bin/jupyter lab` without changing the `PATH` environment variable.
`127`		`-`
`128`		`-### Prerequisites and Supported Browsers`
`129`		`-`
`130`		`-The latest versions of the following browsers are currently _known to work_:`
`131`		`-`
`132`		`-- Firefox`
`133`		`-- Chrome`
`134`		`-- Safari`
`135`		`-`
`136`		`-See our [documentation](https://ciusji.gitbook.io/elixirnote/guides/installation) for additional details.`
`137`		`-`
`138`	`45`	`## Getting Help`
`139`	`46`
`140`	`47`	`We encourage you to ask questions on the [Discourse forum](https://github.com/orgs/ElixirNote/discussions). A question answered there can become a useful resource for others.`
`@@ -159,9 +66,3 @@ ElixirNote follows the Jupyter [Community Guides](https://jupyter.readthedocs.io`
`159`	`66`
`160`	`67`	`ElixirNote uses a shared copyright model that enables all contributors to maintain the`
`161`	`68`	`copyright on their contributions. All code is licensed under the terms of the revised [BSD license](https://github.com/ElixirNote/elixirnote/blob/main/LICENSE).`
`162`		`-`
`163`		`-## Elixir Teams`
`164`		`-`
`165`		`-![elixir-intro](/jupyterlab/staging/assets/elixirnote-intro.svg)`
`166`		`-`
`167`		`-[Welcome to joins 👏👏👏](https://guinsoolab.github.io/glab).`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 34e2669

File tree

2 files changed

2 files changed

`‎README.md‎`

0 commit comments