Skip to content
This repository has been archived by the owner on Nov 28, 2023. It is now read-only.

Commit

Permalink
Merge pull request #25 from ramantehlan/feat-readme
Browse files Browse the repository at this point in the history
Adding README | For issue #22
  • Loading branch information
captainsafia authored Feb 10, 2020
2 parents e03b597 + bef337e commit 5b8eb14
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 0 deletions.
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2020, nteract contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# nteract Play
<p>
<img align= "left" src="https://avatars0.githubusercontent.com/u/12401040?s=200&v=4" width="160">
nteract play is a web application that provides 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.
</p><br><br><br><br>

## Index

- [Development](#development)
- [Pre-Requisites](#pre-requisites)
- [Developmen Environment](#development-environment)
- [Community](#community)
- [Contribution](#contribution)
- [License](#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** <br>
If you think you have encountered a bug, and I should know about it, feel free to report it [here](https://github.com/nteract/play/issues/new) and I will take care of it.

2. **Request a feature** <br>
You can also request for a feature [here](https://github.com/nteract/play/issues/new), and if it will viable, it will be picked for development.

3. **Create a pull request** <br>
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](https://github.com/nteract/play/issues) and make a pull request.

> If you are new to open-source, make sure to check read more about it [here](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) and learn more about creating a pull request [here](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
## License
[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)

1 comment on commit 5b8eb14

@vercel
Copy link

@vercel vercel bot commented on 5b8eb14 Feb 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.