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

38 lines
966 B
Markdown
Raw Normal View History

2020-03-01 21:18:41 +00:00
# [`uni.steffo.eu`](https://uni.steffo.eu)
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!
![maintenance: actively-developed](https://img.shields.io/badge/maintenance-actively--developed-brightgreen)
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
git clone https://github.com/Steffo99/uni.steffo.eu.git
cd "uni.steffo.eu"
npm install
npm run start
```
### Updating the website
To update the published website, run in the previously cloned folder:
```bash
npm run build
git add docs
git commit -m "Update website"
git push
```
2020-03-01 20:34:19 +00:00
[GitHub Pages](https://pages.github.com/) will do the rest.