mirror of
https://github.com/Steffo99/unisteffo.git
synced 2024-11-25 01:14:21 +00:00
🗒 Update README.md
This commit is contained in:
parent
077caa97a5
commit
7fcdfadc27
2 changed files with 22 additions and 1 deletions
|
@ -43,6 +43,7 @@
|
|||
</indentOptions>
|
||||
</codeStyleSettings>
|
||||
<codeStyleSettings language="JavaScript">
|
||||
<option name="RIGHT_MARGIN" value="999" />
|
||||
<option name="BLANK_LINES_AFTER_IMPORTS" value="2" />
|
||||
<option name="BLANK_LINES_AROUND_CLASS" value="2" />
|
||||
<option name="ELSE_ON_NEW_LINE" value="true" />
|
||||
|
|
22
README.md
22
README.md
|
@ -1,6 +1,6 @@
|
|||
# ![Appuntiweb](public/opengraph.png)
|
||||
|
||||
A React app I use to prepare for university exams!
|
||||
A website containing the material I made to prepare for university exams!
|
||||
|
||||
## Contributing
|
||||
|
||||
|
@ -26,3 +26,23 @@ npm run start
|
|||
To update the published website, just push the commit to the `main` branch.
|
||||
|
||||
[Render](https://render.com/) 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][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
|
||||
|
||||
Some Components are temporarily implemented here pending introduction in [`bluelib`][5]: they are located in `/src/components/`.
|
||||
|
||||
[5]: https://github.com/RYGhub/bluelib
|
||||
|
||||
### Per-page components
|
||||
|
||||
Some Components specific to a certain page are implemented in the page's own directory: for example, `/routes/Gestinfo/components/`.
|
||||
|
|
Loading…
Reference in a new issue