mirror of
https://github.com/Steffo99/unisteffo.git
synced 2024-11-23 00:14:21 +00:00
34 lines
966 B
Markdown
34 lines
966 B
Markdown
# [`uni.steffo.eu`](https://uni.steffo.eu)
|
|
|
|
A [Preact](https://preactjs.com/) website with all things I'm using to prepare for university exams!
|
|
|
|
|
|
|
|
## 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/uni.steffo.eu.git
|
|
cd "uni.steffo.eu"
|
|
npm install
|
|
npm run start
|
|
```
|
|
|
|
### Updating the website
|
|
|
|
To update the published website, bump up the version number in the package.json and run in the previously cloned folder:
|
|
|
|
```bash
|
|
npm run ghpages
|
|
```
|
|
|
|
[GitHub Pages](https://pages.github.com/) will do the rest.
|