-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16 from s8sachin/dev-readme-23-oct-2021
Update README.md
- Loading branch information
Showing
1 changed file
with
14 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,24 @@ | ||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| This project is my portfolio site [s8sachin.github.io](https://s8sachin.github.io) | ||
|
|
||
| ## Available Scripts | ||
| ## Project information | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).<br /> | ||
| In the project directory, you can run: | ||
|
|
||
| ### `yarn start` | ||
| ### Setup | ||
| Clone the repo and run `yarn` or `npm install` to install dependencies | ||
|
|
||
| Runs the app in the development mode.<br /> | ||
| ### Running on local | ||
| Run `yarn start` or `npm start`.<br /> | ||
| This runs the app in the development mode.<br /> | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
|
|
||
| The page will reload if you make edits.<br /> | ||
| You will also see any lint errors in the console. | ||
|
|
||
| ### `yarn test` | ||
|
|
||
| Launches the test runner in the interactive watch mode.<br /> | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
|
|
||
| ### `yarn build` | ||
|
|
||
| Builds the app for production to the `build` folder.<br /> | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
|
||
| The build is minified and the filenames include the hashes.<br /> | ||
| ### Build | ||
| Run `yarn build` or `npm run build`.<br /> | ||
| This builds the app for production to the `build` folder.<br /> | ||
| Your app is ready to be deployed! | ||
|
|
||
| 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 | ||
|
|
||
| ### Analyzing the Bundle Size | ||
|
|
||
| This section has moved here: 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 | ||
|
|
||
| ### Advanced Configuration | ||
|
|
||
| This section has moved here: 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 | ||
|
|
||
| ### `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 | ||
| Checkout recent deployments [here](https://github.com/s8sachin/s8sachin.github.io/deployments).<br /> | ||
| Build created from `yarn build` should be copied over and pushed to [master](https://github.com/s8sachin/s8sachin.github.io/tree/master) branch.<br /> | ||
| This [master](https://github.com/s8sachin/s8sachin.github.io/tree/master) branch will have recent static html, css and js files which will be deployed by gh pages and hoted on github. |