Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 11,273 Commits
.github		.github
.husky		.husky
.vscode		.vscode
applications		applications
changelogs		changelogs
docs		docs
nteract-packages		nteract-packages
packages		packages
scripts		scripts
styleguide-components		styleguide-components
styleguide		styleguide
types		types
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
.pre-commit-config.yaml		.pre-commit-config.yaml
.prettierignore		.prettierignore
.prettierrc.js		.prettierrc.js
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
RELEASING.md		RELEASING.md
SECURITY.md		SECURITY.md
TEST_PLAN.md		TEST_PLAN.md
USER_GUIDE.md		USER_GUIDE.md
babel.config.js		babel.config.js
codecov.yml		codecov.yml
commitlint.config.js		commitlint.config.js
lerna.json		lerna.json
mkdocs.yml		mkdocs.yml
package.json		package.json
renovate.json		renovate.json
requirements.txt		requirements.txt
styleguide.config.js		styleguide.config.js
tsconfig.base.json		tsconfig.base.json
tsconfig.jest.json		tsconfig.jest.json
tsconfig.json		tsconfig.json
typedoc.js		typedoc.js
yarn.lock		yarn.lock

Repository files navigation

the interactive computing suite for you

nteract is an open-source organization committed to creating fantasticinteractive computing experiences that allow people to collaborate with ease.

We build SDKs, applications, and libraries that help you and your team makethe most of interactive (particularly Jupyter) notebooks and REPLs.

To learn more about the nteract open source organization and the rest of ourprojects, please visitour website.

What's in this repo?

This repo is a monorepo. It contains the code for the nteract core SDK andnteract's desktop and web applications. It also contains the documentation forthe SDK and the applications. Here's a quick guide to the contents of themonorepo.

Folder	Description
applications/desktop	Source code for the nteract desktop application. The desktop application is a cross-platform app built usingElectron.
applications/jupyter-extension	Source code the nteract Jupyter extension. This extension can be installed alongside Jupyter classic and JupyterLab in your Jupyter deployments or personal Jupyter server.
packages	JavaScript packages that are part of the nteract core SDK.
changelogs	Changelogs for each release of the nteract core SDK and applications.

How do I contribute to this repo?

If you are interested in contributing to nteract, please read thecontribution guidelines for information on how to set upyour nteract repo for development, how to write tests and validate changes,how to update documentation, and how to submit your code changes for review onGitHub.

How do I use the nteract core SDK?

If you are a developer who wants to build an nteract-based notebook application,check out the following documentation resources for more info.

Link	What's in it?
docs.nteract.io	This page contains our how-to and tutorial style documentation. Get started learning about the nteract core SDK here.
packages.nteract.io	This page contains the API documentation for packages in our core SDK. Bookmark this and use it as a reference when building your nteract-based UI.
components.nteract.io	This page contains the documentation for our suite of composable React components. It contains code samples that you can reference when building your nteract-based UI.

Our documentation is living. We are always making changes and adding morecontent. If you have feedback about the documentation, please open an issuein this repo. If you are interested in submitting a change to our documentationpage, please review thecontribution guidelines andsubmit a pull request.

How do I use the nteract desktop application?

To get started with the nteract desktop app, head over to thenteract homepage to download the application for youroperating system.

Once you've download the app, head over to ourdocumentation page for tutorials and guides onusing the app for your data analysis and science workflows.

Supporting nteract

nteract is a non-profit open-source organization fiscally sponsored byNumFOCUS.If you are interested in supporting development on nteract, please considermaking a recurring donation.

Development on nteract is also supported by the following organizations.