Skip to content

GrottoCenter/grottocenter-front

Repository files navigation

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:

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

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