feat: Initial Commit for Backend

suryatejess commented 3 weeks ago

This is the initial command for the backend side of the school management syste

Description

Please provide a summary of the changes made in this pull request. Include any relevant motivation and context for the changes.

Fixes #171

Type of Change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Documentation update

How Has This Been Tested?

I have used Postman to test the route handler function and since I have used mongodb, I used mongosh to test the database.

Checklist

[ ] My code follows the style guidelines of this project.
[ ] I have performed a self-review of my code.
[ ] I have commented my code, particularly in hard-to-understand areas.
[ ] I have made corresponding changes to the documentation.
[ ] My changes generate no new warnings.
[ ] I have added tests that prove my fix is effective or that my feature works.
[ ] New and existing unit tests pass locally with my changes.

Additional Notes

Add any other context or information that may be helpful for the reviewers.

Summary by CodeRabbit

Release Notes

New Features
- Introduced models for managing Attendance, Billing, Courses, Faculty, Students, and Support within the school management system.
- Added RESTful API endpoints for managing attendance, billing, courses, faculty, and student records.
- Implemented a server setup for handling requests and connecting to the MongoDB database.
Documentation
- Created a package.json file to outline project dependencies and scripts.

These enhancements streamline the management of school operations and improve user experience.

vercel[bot] commented 3 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
universal-box	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 29, 2024 8:24pm

coderabbitai[bot] commented 3 weeks ago

Walkthrough

This pull request introduces a comprehensive school management system template, including new Mongoose schemas and Express routers for managing various entities such as students, faculty, courses, attendance, and billing. The changes encompass the creation of models for each entity and the corresponding API endpoints to facilitate CRUD operations. Additionally, a server file is established to initialize the application and connect to a MongoDB database.

Changes

File Path	Change Summary
`template/Management-System/School/models/attendance.js`	New Mongoose schema for attendance records with fields for student, date, and status.
`template/Management-System/School/models/billing.js`	New Mongoose schema for billing with fields for student, amount, date, status, and description.
`template/Management-System/School/models/course.js`	New Mongoose schema for courses with fields for courseCode, courseName, faculty, and students.
`template/Management-System/School/models/faculty.js`	New Mongoose schema for faculty with fields for facultyID, name, email, password, and courses.
`template/Management-System/School/models/student.js`	New Mongoose schema for students with fields for regno, name, email, password, contactNumber, profile, class, and billing.
`template/Management-System/School/models/support.js`	New Mongoose schema for support tickets with fields for user, message, date, response, and status.
`template/Management-System/School/package.json`	New package.json file specifying project metadata and dependencies.
`template/Management-System/School/routes/attendance.js`	New Express router for attendance management with endpoints for CRUD operations.
`template/Management-System/School/routes/billing.js`	New Express router for billing management with endpoints for CRUD operations.
`template/Management-System/School/routes/courses.js`	New Express router for course management with endpoints for CRUD operations.
`template/Management-System/School/routes/faculties.js`	New Express router for faculty management with endpoints for CRUD operations.
`template/Management-System/School/routes/students.js`	New Express router for student management with endpoints for CRUD operations.
`template/Management-System/School/server.js`	New server file to set up the Express application and connect to MongoDB.

Assessment against linked issues

Objective	Addressed	Explanation
Establish a school management system template (171)	✅
Include Node.js, Express, MongoDB, and EJS (171)	✅
Provide basic functionality for school management (171)	✅

🐇 In a school where learning's the game,
New models and routes, we proudly proclaim.
Attendance, billing, and courses galore,
With each little change, we open the door.
So hop on this journey, let's all take a chance,
In our school management system, let’s dance! 🎉

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

Abhishek-Mallick / universal-box