1
Fork 0
mirror of https://github.com/Steffo99/unisteffo.git synced 2024-11-25 09:24:21 +00:00
triennale-appunti-steffo/README.md

1.7 KiB

Appuntiweb

A website containing the material I made 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 and npm are installed on your machine then run:

git clone https://github.com/Steffo99/appuntiweb.git
cd appuntiweb
npm install --dev
npm run start

Updating the website

To update the published website, just push the commit to the main branch.

Render will do the rest.

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 created with create-react-app using bluelib-react for the styling.

Temporary components

Some Components are temporarily implemented here pending introduction in bluelib: they are located in /src/components/.

Per-page components

Some Components specific to a certain page are implemented in the page's own directory: for example, /routes/Gestinfo/components/.

Code style

Code style is all over the place, as IntelliJ IDEA decided to add newlines pretty much everywhere to enforce a 120-column hard wrap, breaking any sort of code style I was following.