A project created with love using React, Redux, SCSS, Bootstrap 4, Eslint, Prettier, Webpack, Html5. This page documents all steps that are necessary to get this project up and running.
- Nodejs: v8.11.3 (LTS) (Install Nodejs)
- Prefered Dev Machine: MAC (OSX) but can be done in any operating system
git clone https://github.com/bmnepali/books-dashboard.git
-
Go to the project directory:
cd books-dashboard
-
Then run command to install project dependencies
npm install
or simplynpm i
- Run the following command to run the project
npm run start:dev
- Run the following command to run the project
npm run start:prod
Note: This will create a dist
directory in the project root; the files in the directory are ready for deployment.
npm run test
npm run test:watch
npm run test:coverage
npm run test -- -u
(To update the previous component's snapshots)
npm run lint
npm run lint:fix
npm run pretify
npm run test:debug
Where all our production ready project source code is stored. Mostly we dont touch this branch. Except for deployment.
Where all our testing is done. Which means QA will use this branch for testing the solutions. After all things are ok, we merge staging in to master and deploy application. QA will only use this branch.
Where our latest development code is kept. It holds the currently developed features after the Pull Request are approved by devs working on their separate feature branches.
It contains the task wise features developed by one or more developer. Which once approved will be merged into develop branch. E.g: BDA-1001-some-awesome-feature (If you can reflect the task name as branch name, will be better!) But also remember your branch name mnust be concise and as sort as possible.
- Buddha Man Nepali [email protected]