Skip to content

React.run - The fastest way to create React components, right in the browser

License

Notifications You must be signed in to change notification settings

bringking/react-run

Repository files navigation

What is it?

React.run is an in-browser tool that allows you to write, run, and experiment writing React components in the browser with no additional tools or configuration. It's the fastest way to get started learning the patterns and practices of React.

Features

  • Automatic Babel transpilation of React JSX/ES6 code
  • Create and save multiple revisions
  • Add external Javascript and CSS resources
  • Track the state of your component, save that state to the server, and "rehydrate" the state when the revision is loaded
  • Time-travel state debugging, similar to the Redux dev tools
  • Supports 34 different code color styles

Even more features are on the horizon. We are tracking features we would like implement in the Roadmap

Building

React.run is built with a KoaJS server, and stores data using Mongoose and a MongoDB database.

Global dependencies

Ensure you have the following global dependencies installed

Setting up environment

React.run uses dotenv to define process variables for local development. Currently React.run uses just two variables. MONGOLAB_URI or MONGO_URI. The MONGOLAB_URI is used for the production database. To run React.run locally, you will need to define one of these variables in your environment. You can do this by setting up a .env in the root directory with a Mongo URI string to your local database-

MONGO_URI=mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]

The simplest version of this with a local mongo instance would look like - MONGO_URI=mongodb://localhost/reactrun

Running the code

Once the global dependencies have been installed, you can run

npm install

then

npm run develop

to start the build process and the local server.

Running the tests

There aren't tests currently, but we are working on some!

Contributing

Contributions are welcome! We have a lot of ideas in the Roadmap, and bugs and features flagged in the issues. Feel free to tackle any of the un-implemented features. Please make sure if you plan on tackling a feature, that you call it out in an issue so we can talk about it.

About

React.run - The fastest way to create React components, right in the browser

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published