ProzillaOS/docs
2023-07-16 12:37:01 +02:00
..
contributing Updated README.md 2023-07-15 14:22:50 +02:00
react Added documentation 2023-07-15 14:17:03 +02:00
README.md Updated documentation 2023-07-16 12:37:01 +02:00

Documentation

Table of contents

Overview

Quickstart

  1. Clone this repository.
  2. Run npm install.
  3. Run npm start and visit localhost:3000.

Development

  1. Run npm start and watch your changes live at 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 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.