2021-03-28 02:52:49 +00:00
# 
2021-01-25 16:25:08 +00:00
2021-07-16 22:21:04 +00:00
A website containing the material I made to prepare for university exams!
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
## Contributing
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
All contributions are welcome!
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
Please help me making this an useful resource to all students everywhere, and correct mistakes if you find them! :D
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
## Developing
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
### Running a local copy
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +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:
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
```bash
git clone https://github.com/Steffo99/appuntiweb.git
cd appuntiweb
npm install --dev
npm run start
```
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
### Updating the website
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
To update the published website, just push the commit to the `main` branch.
2021-01-25 16:25:08 +00:00
2021-03-28 02:34:55 +00:00
[Render ](https://render.com/ ) will do the rest.
2021-07-16 22:21:04 +00:00
Pull Requests are previewed through Render as well: when the deploy is complete, a bot will comment with the preview link.
## Structure
The website is a [Single Page App][1] created with [`create-react-app`][2] using [`bluelib-react`][3] for the styling.
[1]: https://en.wikipedia.org/wiki/Single-page_application
[2]: https://create-react-app.dev/
[3]: https://github.com/RYGhub/bluelib-react
### Temporary components
2021-07-16 22:24:00 +00:00
Some Components are temporarily implemented here pending introduction in [`bluelib`][4]: they are located in `/src/components/` .
2021-07-16 22:21:04 +00:00
2021-07-16 22:24:00 +00:00
[4]: https://github.com/RYGhub/bluelib
2021-07-16 22:21:04 +00:00
### Per-page components
Some Components specific to a certain page are implemented in the page's own directory: for example, `/routes/Gestinfo/components/` .
2021-07-16 22:24:00 +00:00
### Code style
Code style is all over the place, as [IntelliJ IDEA][5] decided to add newlines pretty much everywhere to enforce a 120-column hard wrap, breaking any sort of code style I was following.
[5]: https://www.jetbrains.com/idea/
