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

27 lines
751 B
Markdown
Raw Normal View History

2022-06-29 08:23:00 +00:00
# Contributing
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
### 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/appuntiweb-omega.git
cd appuntiweb-omega
yarn install
yarn run dev
```
### Updating the website
To update the published website, just push the commit to the `main` branch.
[Vercel](https://vercel.com/) will do the rest.
Pull Requests are previewed through Vercel as well: when the deploy is complete, a bot will comment with the preview link.