Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
- v0.11.0 documentation updates
  • Loading branch information
aaronjudd committed Jan 20, 2016
1 parent 5acce54 commit 108d52d
Showing 1 changed file with 18 additions and 67 deletions.
85 changes: 18 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,95 +4,46 @@ Reaction is a modern reactive, real-time event driven ecommerce platform.
Reaction is built with JavaScript (ES6), Meteor, Node.js and works nicely with Docker.

## Status
- 0.10.1 Master
- 0.11.0 Development (0.10.0 stability iteration)
- 0.12.0 New feature releases
- 0.11.0 Master
- 0.12.0 Development (new feature release)

Currently good for contributing/observing progress, testing. It goes without saying that we're constantly refactoring, even things that are functionally done. We'd encourage due diligence in production usage, be very comfortable with the code, and risk tolerant. There are still many parts in development!

## Installation
## Docs
Installation, configuration and development documentation is available on [docs.reactioncommerce.com](https://docs.reactioncommerce.com/)

```
Node.js and NPM are required. Install from http://nodejs.org/
```
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.

To install Meteor + Reaction, and start the latest release:
## Installation
> Reaction requires [Meteor](https://www.meteor.com/install), [Node](http://nodejs.org/), [npm](https://www.npmjs.com/) and [ImageMagick](http://www.imagemagick.org/script/binary-releases.php)
```bash
curl https://install.meteor.com | /bin/sh
git clone https://github.com/reactioncommerce/reaction.git
cd reaction && git checkout master # default branch is development
./reaction
cd reaction
./reaction install
```

Additional installation options are in the [developer documentation](https://github.com/reactioncommerce/reaction/blob/development/docs/developer/installation.md).
Developers using **Windows** should review the [Windows specific installation requirements for Meteor and Reaction](https://docs.reactioncommerce.com/reaction-docs/development/requirements).

_Note: When using a standalone MongoDB server, make sure you are using version 2.6 or later._
Additional setup options, such as how to set the default credentials, can be found in the [installation](https://docs.reactioncommerce.com/reaction-docs/development/installation) and [configuration documentation](https://docs.reactioncommerce.com/reaction-docs/development/configuration).

_Note: for windows installation you also need:_
- OpenSSL x86 ([windows installer](https://slproweb.com/products/Win32OpenSSL.html))
- Visual Studio 2008 redistributables
- Git + msysGit ([git-for-windows/git](https://github.com/git-for-windows/git/releases))
- ImageMagick

If you want to use shell scripts under Windows:
- Create file named `meteor` inside `%localappdata%\.meteor` with following contents:
- !/bin/sh
- cmd //c "$0.bat" "$@"
- Run shell scripts from `Git Bash`. For example:
- cd reaction/
- bin/clone-packages.sh
- bin/reset
_Note: When using a standalone MongoDB server, make sure you are using version 2.6 or later._

## Packages
Atmosphere [Meteor Packages for Reaction](https://atmospherejs.com/?q=reaction)
Meteor [Atmosphere packages for Reaction](https://atmospherejs.com/?q=reaction)

Docker images are available on the [Docker Hub](https://hub.docker.com/u/reactioncommerce/).

## Roadmap
As with all development, some items are ahead of schedule, and some are not. Here's how to get the details:

For a high level review our roadmap, take a look at the vision page [Reaction Vision](http://reactioncommerce.com/vision)

For grouping of development channels by feature see project milestones: [https://github.com/reactioncommerce/reaction/milestones](https://github.com/reactioncommerce/reaction/milestones)

And finally for the kanban-esque, hardcore real time progress view, take a look our [waffle board](https://waffle.io/reactioncommerce/reaction)

## Developer Documentation
[Getting started guide](http://blog.reactioncommerce.com/how-to-get-involved-with-reaction-commerce/)

[Installation](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/installation.md)

[Overview](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/overview.md)

[Methods](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/methods.md)

[Package Development](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/packages.md)

[Theme Development](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/themes.md)

[i18n Translations](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/i18n.md)

[Workflow](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/workflow.md)

[Schemas](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/schema.md)

[Imports](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/import.md)

[Template Development](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/templates.md)

[Deploying](https://github.com/reactioncommerce/reaction/tree/development/docs/developer/deploying.md)

### Code Repositories
Hey! Where's all the code!?
With ongoing feature development, and strong community contributions, we have a fluid roadmap.

Most of it is in now in the local `reaction/packages`.
For a high level review our roadmap, take a look at the [Reaction vision page](http://reactioncommerce.com/vision).

Additional packages are also on [Atmosphere](https://atmospherejs.com/?q=reaction) and [GitHub](https://github.com/reactioncommerce/).
For grouping of development channels by feature, review the [project milestones](https://github.com/reactioncommerce/reaction/milestones).

We welcome pull requests to the latest `development` version branch.
And finally for the kanban-esque, hardcore real time progress overview of Reaction, take a look our [waffle board](https://waffle.io/reactioncommerce/reaction)

# Feedback
## Feedback
**GitHub Issues** on the [Reaction](https://github.com/reactioncommerce/reaction) project are the best way to let us know about a feature request, or to report an issue.

Join us on our **[Gitter chat room](https://gitter.im/reactioncommerce/reaction)** to discuss, communicate, and share community support.

0 comments on commit 108d52d

Please sign in to comment.