From 0008d7dc4b9caafad1364f2849f231db01c95d5f Mon Sep 17 00:00:00 2001 From: Prozilla Date: Sun, 16 Jul 2023 12:37:01 +0200 Subject: [PATCH] Updated documentation --- docs/README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index d303cc0..abf198b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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/). \ No newline at end of file +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. \ No newline at end of file