Skip to content

Latest commit

 

History

History
90 lines (52 loc) · 5.91 KB

README.md

File metadata and controls

90 lines (52 loc) · 5.91 KB

Reaction

bitHound Overall Score bitHound Dev Dependencies bitHound Code Circle CI Gitter

Reaction is an event-driven, real-time reactive commerce platform built with JavaScript (ES6). It plays nicely with npm and Docker, and is based entirely on JavaScript, CSS, and HTML.

Reaction v.1.0.0

Features

Reaction’s out-of-the-box core features include:

  • Drag-and-drop merchandising
  • Order processing
  • Payments
  • Shipping
  • Taxes
  • Discounts
  • Analytics
  • Integration with dozens of third-party apps

And, since anything in our codebase can be extended, overwritten, or installed as a package, you may also develop, scale, and customize anything on our platform.

Installation

reaction-cli installation

npm install -g reaction-cli
reaction init
cd reaction
reaction

For more information on setup and configuration, check out the installation and configuration docs.

Participation

If you are interested in participating in the development of Reaction, that's really great!

Our community guidelines can be found in our documentation. This is a good place to start getting more familar with Reaction.

The Reaction Gitter channel and forum are good places to engage with core contributors and the community.

Planning

For a high level review our roadmap, take a look at the Reaction features page.

For a kanban-esque, hardcore, real time progress overview of all Reaction Commerce projects use our project board.

Testing

Testing is another great way to contribute. If you do discover a bug, create an issue to report it.

Integration tests can be run at the command line with reaction test. Use npm run-script test-local to run local tests.

Documentation

The Reaction documentation source is located in the reaction-docs repository, while the documentation site is the reactioncommerce/redoc application.

Deployment

We require that all releases are deployable as Docker containers. Athough we haven't tested out other methods of deployment, our community has documented deployment strategies for Heroku, AWS, Digital Ocean, and Galaxy.

Docker

Docker images are pushed when Reaction sucessfully builds and passes all tests on the master or development branches. These images are released on Reaction Commerce Docker Hub. There are two images available: reactioncommerce:prequel - the latest development image and reactioncommerce:reaction, the master image.

Contributing

Want to contribute? That's great! Here's you can get started.

Check out our Issues page, and if you find something you want to work on, let us know in the comments. If you're interested in a particular project and you aren’t sure where to begin, feel free to ask. Start small!

If your contribution doesn't fit with an existing issue, go ahead and create an issue before submitting a Pull Request. This will allow the Reaction team to give feedback if necessary.

Pull Requests should:

Be sure to read our Community Guidelines to get more familiar with Reaction. And if you have any questions or comments, feel free to reach out via Gitter or our forums.

What's Next

For an overview of our roadmap, visit our Features & Roadmap page. Or, if you'd like to see what we're doing in real time, check out our Project Board. You can also see what we're doing by project or by release date.