A React-based game application with GDPR compliance, Storybook integration, and automated documentation.
| Field | Info |
|---|---|
| Author | Okocha |
| Date | May 2026 |
| Repository | Mirariel/COP |
| Technology | Purpose |
|---|---|
| React 18 | UI Framework |
| Zustand | State Management |
| React Router DOM v6 | Routing |
| Tailwind CSS | Styling |
| react-hook-form + yup | Forms & Validation |
| Storybook | Component Development |
| JSDoc | Documentation Generation |
The project uses the following configuration files:
| File | Purpose |
|---|---|
.env |
Environment variables |
tailwind.config.js |
Tailwind CSS configuration |
.storybook/main.js |
Storybook configuration |
jsdoc.json |
JSDoc configuration |
npm installnpm startnpm run buildnpm run storybooknpm run docsnpx license-checker --markdown > LICENSE_REPORT.mdThis project is licensed under the MIT License.
MIT was chosen because:
- The project is open-source and educational
- No patent protection is required
- Maximum freedom for contributors and users
- Simple and widely recognized
See the full LICENSE file for details. A full report of third-party dependency licenses can be found in LICENSE_REPORT.md.
This project is GDPR-compliant and includes a cookie consent popup that allows users to:
- Accept or decline non-essential cookies
- View which cookies are used and why
See our Privacy Policy for full details on data handling.
Auto-generated documentation is available in the /docs folder.
To regenerate:
npm run docsInteractive component explorer with stories for all key UI components. To run:
npm run storybook