# Project

Seed admin

# Author

Nicolas Bernier

# Infos

## General

This project needs to be the submodule of a project.
He is not supposed to be launched on its own.

## Seed react

This project is supposed to at the same level than another submodule *seed react*

git@gitlab.com:makeit-group/apps/seed-react.git

(you must have the right access)

## Strucutre

the final structure of a project containing this seed shoudl be

-- project-name/
---- admin (seed-admin)
---- seed (seed-react)


# Src structure

/components : react part

- /enhancers : high order components
- /formHelpers : components by the forms in
- /formItems : components used by redux-form
- /forms : redux-from forms
- /global : global components of the app (Navigation, Header, ...)
- /items : components used in multiple other components
- /layouts : layout components of the app
- /listItems : components used in list
- /pageItems : specific sub-part of pages (if used several times, shoudl be moved to items)
- /routes : page components (endpoint of the react-router)
- /structure : structural components taking children

/store : redux part

- /actions
- /apis
- /reducers
- /sagas
- /utils

/styles : general scss

/types : flow types

# Generation

Make sure to have plop installed globally

sudo npm i -g plop

then simply run the following command and follow the terminal instructions

plop

# Icons

We use this librairie (check in dependencies)

https://react-icons.netlify.com/#/

# Eslint

Could be removed as it should be present in the parent
