Skip to content

Latest commit

 

History

History
166 lines (125 loc) · 6.67 KB

README.md

File metadata and controls

166 lines (125 loc) · 6.67 KB
Raw

Contributors Forks Stargazers Issues


Logo

Reactypter

a web-based interactive development environment for javascript notebooks


npm package · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

React

Reactypter is a web-based interactive development environment for javascript notebooks, code, and MD. Reactypter is flexible: configure and arrange the user interface to support a wide range of workflows in web development. Reactypter is extensible and modular: write plugins that add new components and integrate with existing ones.

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

To build the site for development:

Installation

Usage

  1. Open terminal
  2. Run npm i -g reactypter to install the package
  3. After installing, Run npx reactypter serve to start the notebook
  4. Go to localhost:4005 (By default, It starts at port 4005)
  5. you can change the port to 1000 for example by doing so npx reactypter serve -p 1000 or npx reactypter serve --port 1000 or npx reactypter serve --port=1000
  6. After finishing writing your notebook, you will find notebook.js file in the directory you started at
  • You can change the saved-file name simply by stating the desired name in npx command. For example if you want it to be proj.js you will run npx reactypter serve proj.js
  • You can import any npm library inside your cells
  • As an alternative to console.log , You can show the value of any variable in the preview screen by using show function. For exmaple if you have const x=5; and you want to show it, you'd write show(x)

Screenshots

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Install Node.js and npm
  2. Fork & Clone the Project
  3. Run npm install in the root folder
  4. Run npm start - it should now parallel start different packages
  5. Now go to packages/cli/dist and run node index.js serve to launch the editor
  6. It will start on port 4005 by default
  7. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  8. Commit your Changes (git commit -m 'Add some AmazingFeature')
  9. Push to the Branch (git push origin feature/AmazingFeature)
  10. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/hanaffi/reactypter

Acknowledgements