AUXILIN_README.md

Koa React starter

Koa React starter is what we think an ideal starting point for the most React.JS frontend applications. It is based on the following primary technologies:

• react
• react-router
• webpack
• postcss
• eslint
• koa

Application structured in a way, which we find most efficient in both short and long term projects. The main intention of the current structure is to keep logical components close to each other and define clear structure for the common things, such as routers, store, api wrappers, reducers, action creators, store selectors.

Explanations of the files structure.

1. src/client/components - this folder consist all UI components. Root level folders (such as profile, index) are typically pages of your application. Every such component should have all files related to the page: images, style files, jsx files, sub components. This folder also consist two none page components: common and layout. Common folder should have all common components which are reused in at least two root level components. Layout - represent a layout of your application and should consist all layout related logic and other components, such as headers, footers, sidebars.
2. src/client/components/routes.jsx - this file should consist all routes for your client side application.
3. src/client/helpers - this folder should consist off common helpers used in other components, such as date formatters, api wrappers, common functions and all other files that does not fit current structure. If you don't know where to put certain file - put it into this folder and we will eventually figure out the right place for it.
4. src/client/resources - a folder consist of all redux/api related things. Typically resource maps 1 to 1 to the api endpoint, but not limited to only api endpoints. Every resource is responsible for management certain part of the redux store. If you need keep something client specific in the redux store, you can create separate resource for it. For example: navigation resource may contain something history of the all opened pages to without 1 to 1 connection to the rest api. Main moving parts of resource:
   • src/client/resources/store.js - initialization logic for the redux store. Combines all reducers, adds redux middlewares.
   • src/client/resources//.actions.js - consist redux action creators for the given resource.
   • src/client/resources//.api.js - consist all api methods of the given resource. Optional.
   • src/client/resources//.reducer.js - consist reducer for the give resource. All reducers combined together in the [store.js](./src/client/resources/store.js).
   • src/client/resource//.selectors.js - consist selectors for the given resource. You should never access store directly, but always use selectors instead. That would simplify things when structure of the store data changes.
5. src/client/services - folder should consist the logic for the the third party service integrations (such as Intercom, Segment, etc). Not limited only to the third party services, but could consist some standalone application related services.

Important things to keep in mind

1. Logical components should be tightly coupled. Keep all component related files, such as images, styles, sub components as close as possible to the component. Do not put component into the common folder for the future use.
2. Two separate page components should be loosely coupled. If there is two page components which use same image - keep two copies of every image within every page. Do not create generic images folder, as all images belong to some ui components.

Conventions

1. Name of all files for components should start from lowercased letter.
2. Code style. (TODO: add link to the common eslint configuration for the javascript)

List of planned improvements

1. Add api wrapper which can be reused in *.api.js files
2. Make two current pages stylish.
3. Add stylish loading screen, while app loading (fake 3 seconds profile loading).