diff --git a/README.md b/README.md index 30d0447..bf79ac6 100644 --- a/README.md +++ b/README.md @@ -22,73 +22,28 @@
-# Getting Started with Create React App +# Getting Started -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +In the project directory: -## Available Scripts +To install required packages, run `yarn` -In the project directory, you can run: +To start development server, run `yarn start` -### `yarn start` +To install a package, run `yarn install package-name` -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +# Points to Remember -The page will reload if you make edits.\ -You will also see any lint errors in the console. +1. **Never ever** work in master branch. It is only for most stable production version. -### `yarn test` +2. **Never** work in dev branch. It is for kinda-stable development version. -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +3. **Always** work by creating a new branch of name template : `your-name/feature-or-bug`. For example, if you are rajiv and you have to work in footer, create branch `rajiv/footer`. -### `yarn build` +4. **Always** create PR to dev branch. -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +5. Please refrain from pushing to upstream after every commit. Only push after your work is done or there are significant changes made. Automatic deploy previews are made and build time is recorded. If updated frequently, we can finish up free build time in netlify. -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +6. We are using open-source icons by iconscout. Choose icons from [here](https://iconscout.com/unicons/explore/line). Check usage [here](https://www.npmjs.com/package/@iconscout/react-unicons). -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `yarn eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) - -### Analyzing the Bundle Size - -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) - -### Making a Progressive Web App - -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) - -### Advanced Configuration - -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) - -### Deployment - -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) - -### `yarn build` fails to minify - -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) +7. Please write styling in relevant scss file. If confused ask. Refrain from using inline styling unless specifically needed by some package.