ScholarSuite is a grade management application for schools. It allows to manage students, classes, school levels, subjects and grades.

Important

This application is only at the design stage. It is not yet developed. But contributions are welcome 😁.

Current state: we are working on the technical design of the application. And in parallel, we are working on the design of the application.

Having your instance of ✨ ScholarSuite ✨

Prerequisites:

• Node.js (LTS version)
• PostgreSQL (version 15 or higher)

1. Clone the repository
2. Install dependencies (without development dependencies)

npm ci

3. Create a .env file at the root of the project and add the environment variables. There is an .env.example file that can be used as a template.
4. Instantiate the database

npm run db:generate
npm run db:push
npm run db:seed-prod

5. Build the application. Using Turbo for caching.

turbo build

6. Start the application

npm start

Docs

• Roadmap
• Technical documentation