chore: add improved readme

This commit is contained in:
2021-07-22 17:14:38 -04:00
parent daf5c8ccbf
commit a2912168d2

View File

@@ -1,36 +1,38 @@
## Available Scripts
## grodriguez.dev
In the project directory, you can run:
This website was created for the purpose of learning how to use React. It contains information about myself and my experience. It is currently deployed and can be viewed at [grodriguez.dev](https://grodriguez.dev).
### `npm start`
### Demo
Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
<h1 align="center">
<img src="https://github.com/gio101046/grodriguez.dev/blob/master/readme/demo.gif?raw=true">
<br>
</h1>
The page will reload if you make edits.<br>
You will also see any lint errors in the console.
### Run Project
### `npm test`
To run this project you will need to make sure `npm` and Node is installed on your computer. For more information an how to install `npm` and Node go [here](https://nodejs.org/en/download/).
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.
From the terminal:
### `npm run build`
```bash
# clone the repository using git
$ git clone https://github.com/gio101046/grodriguez.dev.git
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.
# move into cloned repository directory
$ cd grodriguez.dev
The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
# install all dependencies using npm
$ npm install
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
# run npm command to start project
$ npm start
```
### `npm run eject`
Following the above will run the project in development mode and will open a browser to [http://localhost:3000](http://localhost:3000) to view the website.
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
If you arent 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 youre on your own.
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.
## License
[MIT](https://choosealicense.com/licenses/mit/)