| .. | ||
| contributing | ||
| react | ||
| README.md | ||
Documentation
Table of contents
Overview
Quickstart
- Clone this repository.
- Run
npm install. - Run
npm startand visit localhost:3000.
Development
- Run
npm startand watch your changes live at localhost:3000.
Building & deploying
- Run
npm run build, which will compile all the necessary files to thebuilddirectory. - Upload the contents of the
builddirectory to your web server's root folder.
Structure
-
src directory
Contains all code for the application, including CSS, JS and HTML files.
-
public directory
Contains all static files like images, webfonts and vector graphics as well as the 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.