Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Hackabugathon messaging and other copy edits #3052

Merged
merged 6 commits into from
Oct 6, 2017
Merged

Add Hackabugathon messaging and other copy edits #3052

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52f71dc
Add .reaction/ci/config.yml
Oct 2, 2017
385fb3f
Update package.json
Oct 3, 2017
4ab6164
Merge pull request #3003 from reactioncommerce/add-reaction-ci-config
Oct 3, 2017
d09104d
Add Hackabugathon messaging and other copy edits
sophiehe Oct 6, 2017
1a21357
Merge branch 'release-1.5.0' into sophiehe-patch-1
Oct 6, 2017
9ea122a
Update README.md
Oct 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Reaction
# Reaction Commerce

[![bitHound Overall Score](https://www.bithound.io/github/reactioncommerce/reaction/badges/score.svg)](https://www.bithound.io/github/reactioncommerce/reaction) [![bitHound Dev Dependencies](https://www.bithound.io/github/reactioncommerce/reaction/badges/devDependencies.svg)](https://www.bithound.io/github/reactioncommerce/reaction/9a858eb459d7260d5ae59124c2b364bc791a3e70/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/reactioncommerce/reaction/badges/code.svg)](https://www.bithound.io/github/reactioncommerce/reaction) [![Circle CI](https://circleci.com/gh/reactioncommerce/reaction.svg?style=svg)](https://circleci.com/gh/reactioncommerce/reaction) [![Gitter](https://badges.gitter.im/JoinChat.svg)](https://gitter.im/reactioncommerce/reaction?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

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 is an event-driven, real-time reactive commerce platform built with JavaScript (ES6). It plays nicely with npm, Docker, and React.

![Reaction v.1.0.0](https://raw.githubusercontent.com/reactioncommerce/reaction-docs/master/assets/rc-desktop.png)

Expand Down Expand Up @@ -34,9 +34,9 @@ reaction

Reaction requires Meteor, Git, MongoDB, OS Specific Build Tools, and (optionally) ImageMagick.

See our [Requirements Docs](https://docs.reactioncommerce.com/reaction-docs/master/requirements) for requirements that you may need to install for Reaction.
See our [Requirements Docs](https://docs.reactioncommerce.com/reaction-docs/master/requirements) to learn more about requirements for installing Reaction.

For more information on setup and configuration, check out the [installation](https://docs.reactioncommerce.com/reaction-docs/development/installation) and [configuration](https://docs.reactioncommerce.com/reaction-docs/development/configuration) docs.
For more on setup and configuration, check out the [Installation](https://docs.reactioncommerce.com/reaction-docs/development/installation) and [Configuration](https://docs.reactioncommerce.com/reaction-docs/development/configuration) docs.

### Planning

Expand All @@ -48,9 +48,9 @@ Specific features in progress are found on the [Reaction repository's milestones

### Documentation

Multiple branches, release documentation is found at <https://docs.reactioncommerce.com>
Release documentation across multiple branches can be found at <https://docs.reactioncommerce.com>.

The Reaction documentation source is located in the [reaction-docs](https://github.com/reactioncommerce/reaction-docs) repository, while the documentation site is the [reactioncommerce/redoc](https://github.com/reactioncommerce/redoc) application.
The Reaction documentation source is located in the [reaction-docs](https://github.com/reactioncommerce/reaction-docs) repository, while the documentation site is in the [reactioncommerce/redoc](https://github.com/reactioncommerce/redoc) application.

### Community

Expand All @@ -65,32 +65,34 @@ Our [community guidelines](https://docs.reactioncommerce.com/reaction-docs/maste

### Contributing

Star us on GitHub, it helps!
Star us on GitHub — it helps!

If you are interested in participating in the development of Reaction, that's great! Check out the [issues](https://github.com/reactioncommerce/reaction/issues) page, starting with the [`Pull Requests Encouraged`](https://github.com/reactioncommerce/reaction/issues?q=is%3Aissue+is%3Aopen+label%3Apull-requests-encouraged) and [`Verified Reproducible`](https://github.com/reactioncommerce/reaction/issues?q=is%3Aopen+is%3Aissue+label%3Averified-reproducible) labeled issues. If you find something you want to work on, let us know in the issue comments.
Interested in participating in the development of Reaction? That's really great! Before you get started, please review our [Community Guidelines](https://docs.reactioncommerce.com/reaction-docs/master/guidelines).

If you're interested in a particular [project](https://github.com/reactioncommerce/reaction/projects), like [Marketplace](https://github.com/reactioncommerce/reaction/projects/9) and you aren’t sure where to begin, feel free to ask a core team member in the corresponding project [forum](https://gitter.im/reactioncommerce/home).
The [Reaction Gitter room](https://gitter.im/reactioncommerce/reaction) and [forum](https://forums.reactioncommerce.com/) are good places to engage with core contributors, the community, and to get familiar with Reaction.

If your contribution doesn't fit with an existing issue, go ahead and [create an issue](https://github.com/reactioncommerce/reaction/issues/new) before submitting a [Pull Request](https://help.github.com/articles/about-pull-requests/). This will allow the Reaction team to give feedback if necessary.
Check out the [Issues](https://github.com/reactioncommerce/reaction/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](https://github.com/reactioncommerce/reaction/projects) 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](https://github.com/reactioncommerce/reaction/issues/new) before submitting a [Pull Request](https://help.github.com/articles/about-pull-requests/). This will allow the Reaction team to give feedback if necessary.

Pull Requests should:

- Be very focused in scope. Smaller scopes are easier for us to digest and approve.
- Be very focused in scope. PRs with smaller scopes are easier to digest and approve.
- Note any existing associated issues.
- Lint and adhere to the [Reaction style guide](https://docs.reactioncommerce.com/reaction-docs/master/styleguide).
- Pass both [acceptance tests and unit testing](https://docs.reactioncommerce.com/reaction-docs/master/testing-reaction).

### Testing

Testing is another great way to contribute. If you do discover a bug, [create an issue](https://github.com/reactioncommerce/reaction/issues/new) to report it.
Testing is another great way to contribute. If you do discover a bug, [create an Issue](https://github.com/reactioncommerce/reaction/issues/new) to report it.

Integration tests can be run at the command line with `reaction test`.

### Deployment

We ensure that all releases are deployable as [Docker](https://www.docker.com/) containers. While we don't regularly test other methods of deployment, our community has documented deployment strategies for AWS, [Digital Ocean](https://gist.github.com/jshimko/745ca66748846551692e24c267a56060), and Galaxy.

For an introduction to Docker deployment, [the Reaction deployment guide](https://docs.reactioncommerce.com/reaction-docs/master/deploying) has detailed examples. Reaction Commerce also offers a managed deployment platform integrated with the Reaction command line.
For an introduction to Docker deployment, the [Reaction deployment guide](https://docs.reactioncommerce.com/reaction-docs/master/deploying) has detailed examples. We also offer [Reaction Platform](https://reactioncommerce.com/hosting), a managed deployment platform integrated with the Reaction command line.

### License

Expand Down