Repository: reactioncommerce/reaction

Stars: 12408

README.md Copy Chapter

<h1 align="center">
Mailchimp Open Commerce (formerly Reaction Commerce)
</h1>

<h4 align="center">
<a href="https://mailchimp.com/developer/open-commerce/">Open Commerce Website</a> |
<a href="https://twitter.com/getreaction">Twitter</a> |
<a href="https://mailchimp.com/developer/open-commerce/">Documentation</a> |
<a href="https://discord.gg/Bwm63tBcQY">Discord</a> |
<a href="https://github.com/reactioncommerce/reaction/discussions">Discussions</a>
</h4>

Mailchimp Open Commerce is an API-first, headless commerce platform built using Node.js, MongoDB, and GraphQL. It plays nicely with npm, Docker and Kubernetes.

!MOC Admin

Features

<table>
<tr><td><strong>Fast</strong></td><td>Returns data in split seconds, and faster queries mean faster web pages</td></tr>
<tr><td><strong>Proven</strong></td><td>Open Commerce fuels sites doing 10's of thousands of orders per day with 100's of thousands of products</td></tr>
<tr><td><strong>Composable</strong></td><td>A flexible plugin system allows you to pick and choose which integrations work best for you</td></tr>
<tr><td><strong>Multi-tenant</strong></td><td>Host multiple shops in the same installation</td></tr>
<tr><td><strong>Scalable</strong></td><td>Start out with a single server and scale up to hundreds</td></tr>
<tr><td><strong>Flexible Products</strong></td><td>Allows Products, with options and variants to fit a wide variety of needs</td></tr>
<tr><td><strong>Inventory</strong></td><td>Track inventory, allow or disallow backorders and more</td></tr>
<tr><td><strong>Shipping</strong></td><td>Integrate with a shipping rate provider or build your own custom table</td></tr>
<tr><td><strong>Taxes</strong></td><td>Integrate with a tax rate provider or build your own custom tax table</td></tr>
<tr><td><strong>Fulfillment</strong></td><td>Flexible fulfillment system allows you create your own fulfillment methods</td></tr>
<tr><td><strong>Order Tracking</strong></td><td>View and manage your orders in the included admin system</td></tr>
<tr><td><strong>Emails</strong></td><td>Customizable templates for Order confirmations and more</td></tr>
<tr><td><strong>Open</strong></td><td>Fully open source. Never be locked in again</td></tr>
</table>

Getting started

To start working with your own project built on Mailchimp Open Commerce you can start by using our new CLI. The CLI is
the quickest and easiest way to develop on Open Commerce. It allows you to create and work with API, Admin, and Storefront projects all via the command line.

What you need Copy Chapter

In addition, you need to have your system setup for SSH authentication with GitHub

Install the CLI Copy Chapter

npm install -g reaction-cli

You can test to see if it has worked here by running:

reaction help

Creating a project Copy Chapter

You can create your Open Commerce project by running:

reaction create-project api <your-project-name>

cd <your-project-name>

npm install

reaction develop api

Note: Optionally, from within the project-directory you may issue the above command without mentioning the project type and the CLI would check your package.json for the "projectType" and pick it up from there. This expects that the project itself was built using the latest version of the CLI as explained in the above steps.

Example, instead of the above command, you may skip mentioning 'api' and just use:

reaction develop

This will start the Open Commerce GraphQL server and Mongo Server. Press Ctrl+C to stop.

- A sample custom plugin has been installed, and you should see its output in the logs. (Your Sample Plugin)
- To add a new plugin based on our plugin template run:

reaction create-plugin api <your-plugin-name>

cd custom-packages

You now need to change back up to the root:

now you can run:

This plugin will now be loaded the next time you start Open Commerce.
Congratulations!! You're ready to start developing with Open Commerce  Copy Section
See the Complete CLI instructions for how to create your local storefront and admin.

Go to the complete installation instructions to see how to set up your store
API development

If you are working on core plugins (not developing plugins for your own installation) you should follow these 
instructions
What you need  Copy Chapter
- pnpm
- Docker
- Docker Compose
Install PNPM  Copy Chapter

Clone and Start the source  Copy Chapter

Start dev-server with mongo on local:

Start dev-server with mongodb on docker

1. Run release action to create Version PR. This PR will remove all changeset files, bump up packages versions, update CHANGELOG files.
2. Merge Version PR into trunk, CircleCI will publish all the packages into npm.

Prerelease flows Copy Chapter

We love your pull requests! Check out our Good First Issue and Help Wanted` tags for good issues to tackle.
Check out our contributors guide for more information

License Copy Section

Reaction is GNU GPLv3 Licensed