Project
Creobis admin
Author
Nicolas Bernier
Git modules
Seed react
Add this git as a submodule
git@gitlab.com:makeit-group/apps/seed-react.git
(you must have the right access)
Add it as seed/ (the name/path => very important!)
Seed admin
Add this git as a submodule
git@gitlab.com:makeit-group/apps/seed-admin.git
(you must have the right access)
Add it as admin/ (the name/path => very important!)
Strucutre
the final structure of a project containing this seed shoudl be
-- project-name/ ---- admin (seed-admin) ---- seed (seed-react)
Installation
(after gitmodules)
npm i cd seed npm i cd ../admin npm i
or directly
npm i && cd seed && npm i && cd ../admin && npm i && cd ../seed
Structure Project
/components : react part
- /enhancers : high order components
- /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
Seed
The seed containes all the shared logic accross projects
Storybook
cd ./seed yarn storybook
it will also look at the parent stories
Test
cd ./seed yarn test
it will also look at the parent test
Start build
cd ./seed yarn start
yarn build
Icons
Font Awesome is installed in the seed and imported in the admin
Zeus
zeus https://oxaav8d1i7.execute-api.eu-central-1.amazonaws.com/dev/ ./src/config --ts