Skip to content

tasmat-trust/hexagons

Repository files navigation

Hexagons

Hexagons Client

codecov

Hexagons is an assessment system for tracking small steps of academic progress and personal development and is designed for pupils with Special Educational Needs and Disabilities (SEND). It is being developed for and with Torfield and Saxon Mount Academy Trust (TASMAT).

Technical information

This is a Next.js project bootstrapped with create-next-app.

It uses Cypress.js for tests and Codecov.io to measure test coverage.

MaterialUI provides many standard interface components, with ReachUI providing accessible components such as search boxes and the skip to content link.

Getting Started

Clone down this repository and run npm install.

Clone down the backend repository, following the instructions there to setup a local PostgreSQL database and get Strapi up-and-running.

Rename .env.default to env.local.

Run npm run dev and the project will run.

Custom scripts

Please browse ./package.json scripts to learn how to run tests and lint the project; however, a Continuous Integration pipeline (see ./.github/workflows/main.yml) runs tests automatically on every push to the main branch, and a husky pre-commit hook will lint all staged files before committing.

Disable registration

If you wish to only allow Leader accounts to create new teachers, you can disable registration by adding environment variable NEXT_PUBLIC_DISABLE_REGISTRATION=true. To enable registration, remove the environment variable.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published