README.md

Web Application (front-end)

Directory Structure

├──components — UI elements
├──core — Core modules, React hooks, customized theme, etc.
├──icons — Custom icon React components
├──public — Static assets such as robots.txt, index.html etc.
├──routes — Application routes and page (screen) components
├──global.d.ts — Global TypeScript declarations
├──index.html — HTML page containing application entry point
├──index.tsx — Single-page application (SPA) entry point
├──package.json — Workspace settings and NPM dependencies
├──tsconfig.ts — TypeScript configuration
└──vite.config.ts — JavaScript bundler configuration (docs)

Getting Started

$ yarn workspace app start

Scripts

• start [--force] — Launch the app in development mode
• build — Build the app for production
• preview — Preview the production build
• test — Run unit tests
• coverage — Run unit tests with enabled coverage report
• deploy [--env #0] — Deploy the app to Cloudflare (CDN)

References

• https://react.dev/ — React.js documentation
• https://mui.com/joy-ui/getting-started/ — Joy UI documentation
• https://www.typescriptlang.org/ — TypeScript reference
• https://vitejs.dev/ — Front-end tooling (bundler)
• https://vitest.dev/ — Unit test framework