hesiyuan/play

The code base for the nteract Play app

nteract Play

Play with nteract. No installation needed.

We developed nteract play to provide an interactive playground for users to run code samples against a Binder instance.

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

Index

• Development
  • Pre-Requisites
  • Developmen Environment
• Community
  • Contribution
• License

Development

If you want to contribute to this project, read the information given below.

Pre-Requisites

You should be familiar with following to get started.

• HTML/SCSS
• React, Redux, and RxJS
• Familiarity with CLI

pre-requisites the system needs to develop this project.

• NPM or Yarn
• Node

Development Environment

Here are the steps given below to step up the development environment:

1. Fork this repo.
2. Clone the fork to your system. git clone https://github.com/YOUR-USERNAME/play.
3. You can use either yarn install or npm install.
4. To start the dev server npm run dev or yarn dev.
5. To build the application npm run build or yarn build.

Community

Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

1. 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.

2. Request a feature
   You can also request for a feature here, and if it will viable, it will be picked for development.

3. 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.

License

BSD-3-Clause