README.md

ClassMate: Your Software Engineering Assistant

ClassMate is a powerful Express/TypeScript server that serves as your assistant in managing students' assignments, exercises, modules, and other aspects of software engineering education.

Table of Contents

• ClassMate: Your Software Engineering Assistant
  • Table of Contents
  • Features
  • Getting Started
    • Prerequisites
    • Installation
  • Contributing

Features

• User Management: Manage students, instructors, and administrators.
• Assignment Handling: Create, update, and track student assignments.
• Exercise Repository: Store and organize coding exercises for students.
• Module Management: Organize the course content into modules.
• Authentication and Authorization: Secure endpoints with user roles.

Getting Started

Prerequisites

• Node.js (v14.0.0 or later)
• npm (v6.0.0 or later)
• TypeScript (v4.0.0 or later)

Installation

1. Clone the repository:

   git clone https://github.com/your-username/ClassMate.git
   cd ClassMate

2. Installed Dependencies

   npm install

3. Configuration

   1. Copy the .env.example file to .env:

      cp .env.example .env

   2. Update the .env file with your MongoDB connection string and other configuration details.

Contributing

We welcome contributions! To contribute to ClassMate, follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/new-feature.
3. Make your changes and commit: git commit -m 'Add new feature'.
4. Push to the branch: git push origin feature/new-feature.
5. Submit a pull request.