1
Fork 0
mirror of https://github.com/Steffo99/unisteffo.git synced 2024-11-21 23:44:22 +00:00
triennale-appunti-steffo/README.md

35 lines
922 B
Markdown
Raw Permalink Normal View History

2020-09-01 17:20:45 +00:00
# ![Appuntiweb](src/assets/opengraph.png)
2020-03-01 20:25:46 +00:00
2020-03-01 21:18:41 +00:00
A [Preact](https://preactjs.com/) website with all things I'm using to prepare for university exams!
> # See also: [the new version](https://github.com/Steffo99/appuntiweb)
2020-03-01 20:25:46 +00:00
## Contributing
2020-03-01 20:39:43 +00:00
All contributions are welcome!
Please help me making this an useful resource to all students everywhere, and correct mistakes if you find them! :D
## Developing
2020-03-01 20:25:46 +00:00
### Running a local copy
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:
```bash
2020-09-01 17:20:45 +00:00
git clone https://github.com/Steffo99/appuntiweb.git
cd appuntiweb
npm install --dev
2020-03-01 20:25:46 +00:00
npm run start
```
### Updating the website
2020-06-29 15:06:37 +00:00
To update the published website, bump up the version number in the package.json and run in the previously cloned folder:
2020-03-01 20:25:46 +00:00
```bash
2020-09-01 17:20:45 +00:00
npm run all
2020-03-01 20:25:46 +00:00
```
2020-03-01 20:34:19 +00:00
[GitHub Pages](https://pages.github.com/) will do the rest.