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

31 lines
841 B
Markdown
Raw Normal View History

2022-02-04 18:16:29 +00:00
# Unisteffo + Appuntiweb
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
A website containing the material I made to prepare for university exams!
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
## Contributing
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
All contributions are welcome!
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
Please help me making this an useful resource to all students everywhere, and correct mistakes if you find them! :D
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
## Developing
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
### Running a local copy
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
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:
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
```bash
git clone https://github.com/Steffo99/appuntiweb.git
cd appuntiweb
yarn install
yarn run dev
```
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
### Updating the website
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
To update the published website, just push the commit to the `main` branch.
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
[Vercel](https://vercel.com/) will do the rest.
2022-02-02 04:36:02 +00:00
2022-02-04 18:16:29 +00:00
Pull Requests are previewed through Vercel as well: when the deploy is complete, a bot will comment with the preview link.