Welcome to the primary school SMIS template! This Vue 3 project in Vite is designed to kickstart the development of a student management information system tailored specifically for primary schools. Below, you'll find information on how to set up the project and customize its configuration.
- Maintain comprehensive profiles for each student, including personal information, academic records, attendance history, and health information.
- Enable teachers to take attendance electronically, track tardiness, and generate reports to monitor student attendance patterns.
- Provide tools for teachers to input grades, create assessments, and generate progress reports. Allow parents and students to access grades and performance feedback.
- Allow educators to plan, organize, and manage curriculum content, including lesson plans, syllabi, and educational resources.
- Incorporate features such as messaging, announcements, and newsletters to facilitate communication between teachers, students, parents, and administrators.
- Enable teachers to assign homework electronically, provide instructions, set deadlines, and allow students to submit assignments online. Include features for grading and feedback.
- Build a repository of educational materials, including documents, presentations, videos, and interactive content, accessible to teachers and students.
- Provide a shared calendar for scheduling events, exams, extracurricular activities, parent-teacher meetings, and other school-related events.
- Offer analytics tools to track student progress, identify areas for improvement, and generate insights into academic performance trends.
- Create a dedicated portal for parents to monitor their child's academic progress, attendance, behavior, and communication with teachers.
- Streamline the admissions process, including online applications, document submission, enrollment management, and registration.
- Include features for fee collection, billing, payment processing, and financial reporting to manage school finances efficiently.
- Implement robust security measures to protect sensitive student information and ensure compliance with data protection regulations.
For an optimal development experience, we recommend using Visual Studio Code along with the Volar extension. Volar enhances Vue 3 support in VSCode, making it easier to work with Vue files. Simply install VSCode and Volar (and disable Vetur if it's enabled).
To ensure TypeScript type support for .vue files, we use vue-tsc instead of the default tsc CLI for type checking. Additionally, Volar helps the TypeScript language service recognize .vue types within your editor.
For customization options, refer to the Vite Configuration Reference. You can tailor the project configuration to suit your specific requirements and preferences.
To set up the project, run the following command in your terminal:
npm installThis will install all the necessary dependencies for the project.
During development, you can compile and hot-reload the project by running:
npm run devThis command starts a development server and provides live reloading as you make changes to your code.
For production builds, use the following command:
npm run buildThis command type-checks, compiles, and minifies the project for optimal performance in a production environment.
To run unit tests using Vitest, execute the following command:
npm run test:unitThis command runs unit tests to ensure the reliability and correctness of your codebase.
To ensure code quality and adhere to best practices, lint your code using ESLint:
npm run lintThis command checks your code for potential errors, stylistic inconsistencies, and other issues according to your ESLint configuration.