unimore/triennale-appunti-steffo
unimore/triennale-appunti-steffo
1
Fork 0
mirror of https://github.com/Steffo99/unisteffo.git synced 2024-11-25 01:14:21 +00:00
Code Activity

Update README.md

Browse source
This commit is contained in:
Steffo 2021-03-28 04:34:55 +02:00 committed by GitHub
parent 5adc23cf4c
commit acf437374e
Signed by: github
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
README.md
View file

@ -1,70 +1,30 @@
# Getting Started with Create React App
# ![Appuntiweb](src/assets/opengraph.png)
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
A [Preact](https://preactjs.com/) website with all things I'm using to prepare for university exams!
## Available Scripts
> # See also: [the new version](https://github.com/Steffo99/appuntiweb)
In the project directory, you can run:
## Contributing
### `npm start`
All contributions are welcome!
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Please help me making this an useful resource to all students everywhere, and correct mistakes if you find them! :D
The page will reload if you make edits.\
You will also see any lint errors in the console.
## Developing
### `npm test`
### Running a local copy
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.
If you want to run a local copy of the website, ensure [the latest `nodejs`](https://nodejs.org/it/) and `npm` are installed on your machine then run:
### `npm run build`
```bash
git clone https://github.com/Steffo99/appuntiweb.git
cd appuntiweb
npm install --dev
npm run start
```
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
### Updating the website
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
To update the published website, just push the commit to the `main` branch.
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run 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)
### `npm run 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)
[Render](https://render.com/) will do the rest.