React starter kit based on Atomic Design
Clone or download
Latest commit e52205c Sep 13, 2018

README.md

arclogo

Build Status Coverage Status Gitter chat

ARc (Atomic React) is a React starter kit based on the Atomic Design methodology. It's progressive, which means that you can start with the basic boilerplate and try the other features when you are comfortable.



If you find this useful, please check out Reakit, a toolkit for building composable UI with React.



Branches

Why

I've been a web developer for the past 14 years and after dealing with IE vs. Netscape wars, <table> layouts and flash websites, I can say that we are now living in the best moment in web development. Web components are awesome and React makes it better.

React encourages you to create very small and pure components. However, as your project grows, you will have an increasingly complex components folder. At some point, this will be really huge and hard to maintain.

I had a React project with more than 100 components in the components folder. The first approach I tried to organize it was separating the components by domain (described here), but I realized that most of my components didn't belong to any domain, but were shared. This meant that my problems just moved to the commons folder.

The Atomic Design approach comes handy to solve this problem because it considers the reusability through composition, which is actually what React is. You will have your minimal/stylish components in one folder, pages in another and so on.

Setup

1. Get the source code

Just clone one of the ARc branches:

$ git clone -b master https://github.com/diegohaz/arc my-app
$ cd my-app

You will probably want to remove ARc git history and start a brand new repository:

$ rm -rf .git
$ git init

2. Install dependencies

$ npm install

3. Run the app

$ npm run dev

It will start the development server with HMR on top of it.

http://localhost:3000 — Development server
http://localhost:3001 — Webpack assets server (for redux-ssr only)

Now you can open http://localhost:3000 in browser and start developing.

Contributing

When submitting an issue, use the following patterns in the title for better understanding:

[v0.3.1-redux] Something wrong is not right # the v0.3.1 release of the redux branch
[redux] Something wrong is not right # the actual code of the redux branch
Something wrong is right # general, related to master or not directly related to any branch

PRs are very appreciated. For bugs/features consider creating an issue before sending a PR.

License

MIT © Diego Haz