https://github.com/nteract/nteract

📘 The interactive computing suite for you! ✨
https://github.com/nteract/nteract

data-science desktop-application ipython jupyter jupyter-notebook monorepo notebook nteract react react-components repl zeromq

Last synced: 4 days ago
JSON representation

📘 The interactive computing suite for you! ✨

• Host: GitHub
• URL: https://github.com/nteract/nteract
• Owner: nteract
• License: bsd-3-clause
• Created: 2015-06-15T23:21:49.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-12-30T16:09:02.000Z (12 months ago)
• Last Synced: 2024-11-30T21:43:25.057Z (12 days ago)
• Topics: data-science, desktop-application, ipython, jupyter, jupyter-notebook, monorepo, notebook, nteract, react, react-components, repl, zeromq
• Language: TypeScript
• Homepage: https://nteract.io
• Size: 39.1 MB
• Stars: 6,213
• Watchers: 149
• Forks: 551
• Open Issues: 192
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-jupyter-resources - GitHub - 9% open · ⏱️ 23.07.2022): (Notebook环境)
• best-of-jupyter - GitHub - 11% open · ⏱️ 30.12.2023): (Notebook Environments)
• awesome-jupyter - nteract - Native desktop notebook frontend. <!--lint disable double-link--> (Runtimes/Frontends)
• -awesome-jupyter - nteract - Native desktop notebook frontend. (Runtimes/Frontends)
• awesome-list - nteract
• starred-awesome - nteract - 📘 Desktop, Jupyter Extension, libraries, and more (JavaScript)
• project-awesome - nteract/nteract - 📘 The interactive computing suite for you! ✨ (TypeScript)
• awesome-starred - nteract/nteract - 📘 The interactive computing suite for you! ✨ (react)

README

        


the interactive computing suite for you














nteract is an open-source organization committed to creating fantastic

interactive computing experiences that allow people to collaborate with ease.

We build SDKs, applications, and libraries that help you and your team make

the most of interactive (particularly Jupyter) notebooks and REPLs.

To learn more about the nteract open source organization and the rest of our

projects, please visit [our website](https://nteract.io/).

## What's in this repo?

This repo is a monorepo. It contains the code for the nteract core SDK and

nteract's desktop and web applications. It also contains the documentation for

the SDK and the applications. Here's a quick guide to the contents of the 

monorepo.

| Folder                         | Description |

| ------------------------------ | ----------- |

| applications/desktop           | Source code for the nteract desktop application. The desktop application is a cross-platform app built using [Electron](https://electronjs.org/). |

| 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 the

[contribution guidelines](./CONTRIBUTING.md) for information on how to set up

your nteract repo for development, how to write tests and validate changes,

how to update documentation, and how to submit your code changes for review on

GitHub.

## 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](https://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](https://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](https://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 more

content. If you have feedback about the documentation, please open an issue

in this repo. If you are interested in submitting a change to our documentation

page, please review the [contribution guidelines](./CONTRIBUTING.md) and

submit a pull request.

## How do I use the nteract desktop application?

To get started with the nteract desktop app, head over to the

[nteract homepage](https://nteract.io/) to download the application for your

operating system.

Once you've download the app, head over to our

[documentation page](https://docs.nteract.io/) for tutorials and guides on

using the app for your data analysis and science workflows.

## Supporting nteract

nteract is a non-profit open-source organization fiscally sponsored by

[NumFOCUS](https://numfocus.org/). **If you are interested in supporting development on nteract, please consider [making a recurring donation](https://numfocus.salsalabs.org/donate-to-nteract/index.html).**

Development on nteract is also supported by the following organizations.