Grottocenter-front

The web app frontend for the GrottoCenter project

This project uses Yarn & Yarn workspaces

For the backend server see GrottoCenter/grottocenter-api

Getting Started

• Install NodeJs (v20 minimum) and Yarn
• Run yarn to install dependencies
• Run yarn start to launch the app

By default the app use the production api as backend. To modify it change the REACT_APP_API_URL variable in the packages\web-app\.env file

Packages:

• Main web app

• Configurations:

  • eslint-config
  • eslint-config-typescript
  • prettier-config
  • ts-config

Scripts

• start Start Grottocenter front
• build Build the Grottocenter front
• lint Check linting rules
• lint:fix Same as lint but will also try to fix errors
• e2e:run Run the end to end test suite (require a running app)
• e2e:open Open the end to end test suite browser (require a running app)
• storybook Start storybook
• translations:sync-with-en Compares a translation file with en.json to check synchronization (use: yarn translations:sync-with-en <target-file>)
• translations:update-en Scans JSX files for translation keys and adds missing ones to packages/web-app/public/lang/en.json (automatically sorts the file afterwards)
• translations:sort Sorts translation file keys alphabetically (case-insensitive): node scripts/translations/sort.js <path-to-json-file>

CI

Github Actions is running 2 tasks on push and pull requests on develop :

• Lint
• Azure Static Web Apps deploy

Release and publish

WIP

Production deployment (Azure)

Full wiki article

Project organization

Git-rules

Hooks

To prevent a bad commit, we use the Git hooks husky

Commit type

Commitlint rules define in commitlint config