@nteract/web is a NextJS-based web application that provides a nteract based interactive playground for users to connect to kernels hosted on MyBinder and run code samples against it.
This web application is a great way to test changes on the nteract core SDK without requiring a Jupyter setup on the dev machine. It is also useful for students learning about data science. Researchers can use it to share their work quickly with minimum efforts.
WARNING: This application is in pre-alpha.
- URL Format
- Github Auth
If you want to contribute to this project, read the information given below.
You should be familiar with following to get started.
- Familiarity with CLI
pre-requisites the system needs to develop this project.
- NPM or Yarn
To setup the development.
Clone the nteract monorepo.
Install the dependencies
yarn installand run the build command
yarn buildin the root of the repository.
Go to the
yarn installthe dependencies.
yarn devto start the server.
$ git clone https://github.com/nteract/nteract $ cd nteract $ yarn install
$ cd ./applications/web $ yarn install $ yarn dev
This will start the development server on port
The program/page to handle Github auth is at
@nteract/web/pages/auth/. It is powered by the play-oauth-server. It currently supports only
Github but support for more VCS can be added in future.
|components/||This folder holds all the components used by the application.|
|pages/||This folder holds all the endpoints or pages. To create a new endpoint, create a folder with the endpoint name.
|redux/||The redux store|
|util/||This holds all the internal utility files used in the application.|
Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.
Report a bug
If you think you have encountered a bug, and I should know about it, feel free to report it here and I will take care of it.
Request a feature
You can also request for a feature here, and if it will viable, it will be picked for development.
Create a pull request
It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.
If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.