- Software installation:
- Visual Studio Code
- Currently stable Google Chrome
- [NodeJS v6.11.2][] (for development, testing, previewing, compiling and optimizing processes)
- [Webpack][] locally installed
- Setting up Environment and running app
- Install dependencies: In terminal, cd to this folder:
yarn install
- Run
yarn start
- Install dependencies: In terminal, cd to this folder:
- [React][] v16.2.0 and [Redux][] v^3.0.4 for the Frontend Architecture
- [Webpack] for building and bundling.
- SASS (SCSS dialect) as CSS preprocessor
- Bootstrap as base CSS framework
- [NodeJS v6.11.2][]
- [Webpack][]
- See dependencies in
package.json
Below are list of main components
- React: v16.2.0
- Redux: ^3.0.4
- React-Bootstrap: ^0.32.0
Folder structure is FRACTAL
- Use PascalCase for all folder with components
- Use lowercase for remaining folder names
-
Alignment by TABs (not SPACES, tab width is up to user's preference, but 4-space tab is recommended)
-
Variable Naming:
- use camelCase for variables and function names.
-
Functions:
- Prefix function name with 'on' if it is an ordinary event handling function
Refer to
.eslintrc
for detailed global rules [TBD]
- Prefix function name with 'on' if it is an ordinary event handling function
Refer to
- Comments:
- Every CSS component/file (at high level)
- OOCSS:
- NO IDs in CSS
- Install Nodejs [v16.2.0]
- Install GIT
- Install React Developer Tools for Google Chrome.
- Go to Project root directory and run
yarn install
. This will install Project dependencies. - cd api && npm installation
- cd .. to root directory
- Run
yarn start
. This will start development node server. - Go to http://localhost:3000/ from Browser.