zimfuzzysearch v0.1.0

Frontend Documentation Portal

Repo for the Frontend-Devtools Client Based on:

• React + React Router
• Typescript

Required Guideline "knowledge"

• React Basics Guideline
• Git Basics Guideline
• Gitlab/Git development workflow Guideline (to be implemented)
• Node Basics Guideline (to be implemented)
• Typescript Basics Guideline
• Main Page of the Frontend-Docu-Portal for orientation/ strategical overview / embedment in architecture etc.

Acknowledgments:

• based on Create React app and of Course React.
  • Typescript template

Prerequisits

• Node.js
• npm

Installation

• Clone repo
• inside the root (where the package.json is) run:

npm i

• this will install all required dependencies declared in package.json

Development

npm start

• starts the development server

Build / Production

npm build

• builds the application

Deployment

• atm the app is deployed on github pages via pushing it to the gh-pages branch at https://github.com/zimFrontendCoordination/zimFrontendDocuClient