Skip to content

Commit

Permalink
Describe project structure in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
zalmoxisus committed Oct 20, 2015
1 parent 4ba9d3b commit b8c9185
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ The developing is the same as for the web apps with React and Redux, just use th

The app example is edited from [Redux Counter example](https://github.com/rackt/redux/tree/master/examples/counter) using [Redux Persist](https://github.com/rt2zz/redux-persist), based on [React Chrome Extension Boilerplate](https://github.com/jhen0409/react-chrome-extension-boilerplate).

## Structure

- [browser-redux-sync](https://github.com/zalmoxisus/browser-redux-sync): states syncing module.
- [browser-redux-bg](https://github.com/zalmoxisus/browser-redux-bg): messaging module - send redux actions (from popup, windows or inject pages) to be called in the background by their function name.
- `src/app`: React cross-browser application.
- `src/browser`: sources for the extension and Chrome app.
- `test/app`: tests for Redux actions and reducers, and for React components (using [Legit Tests](https://github.com/Legitcode/tests)).
- `test/chrome`: tests for Chrome app and extension (using [chromedriver](https://www.npmjs.com/package/chromedriver), [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver)).

## Included

- [react](https://github.com/facebook/react)
Expand Down Expand Up @@ -101,12 +110,6 @@ npm run test:chrome
npm test
```

#### Structure

* `test/app`: tests for Redux actions and reducers, and for React components (using [Legit Tests](https://github.com/Legitcode/tests))
* `test/chrome`: for Chrome app and extension (using [chromedriver](https://www.npmjs.com/package/chromedriver), [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver))


## Roadmap

- [x] Chrome app
Expand Down

0 comments on commit b8c9185

Please sign in to comment.