Updated documentation

This commit is contained in:
Prozilla 2023-07-16 12:37:01 +02:00
parent 1ec383ed7f
commit 0008d7dc4b
No known key found for this signature in database
GPG key ID: 5858DFE71CAF31EE

View file

@ -7,8 +7,31 @@
## Overview
### Getting started
### Quickstart
1. Clone this repository.
2. Run `npm install`.
3. Run `npm start` and visit [localhost:3000](http://localhost:3000/).
3. Run `npm start` and visit [localhost:3000](http://localhost:3000/).
### Development
1. Run `npm start` and watch your changes live at [localhost:3000](http://localhost:3000/).
### Building & deploying
1. Run `npm run build`, which will compile all the necessary files to the `build` directory.
2. Upload the contents of the `build` directory to your web server's root folder.
### Structure
- [src](../src) directory
Contains all code for the application, including CSS, JS and HTML files.
- [public](../public) directory
Contains all static files like images, webfonts and vector graphics as well as the [index.html](../public/index.html) file, which contains all metadata and contains all bundled scripts after the build step.
- [docs](.) directory
You are here. This directory contains all documentation for this project.