44 lines
No EOL
1.4 KiB
Markdown
44 lines
No EOL
1.4 KiB
Markdown
# Documentation
|
|
|
|
## Table of contents
|
|
|
|
- [Contributing](contributing)
|
|
- [React](react)
|
|
|
|
## Overview
|
|
|
|
### Quickstart
|
|
|
|
1. Clone this repository.
|
|
2. Run `npm install`.
|
|
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.
|
|
|
|
#### Deploy to GitHub Pages
|
|
|
|
1. Change the "homepage" property in [package.json](../package.json) to your domain.
|
|
2. Make sure the package `gh-pages` is installed.
|
|
2. Run `npm run deploy` - This will create a new build by running the redeploy script and then push the build folder to a branch called `gh-pages`.
|
|
3. Configure your GitHub Pages to deploy the `gh-pages` branch.
|
|
|
|
### 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. |