{"id":31644459,"url":"https://github.com/olesiakubska/teaching-load-api","last_synced_at":"2026-04-13T14:33:44.806Z","repository":{"id":310986953,"uuid":"1042001575","full_name":"OlesiaKubska/teaching-load-api","owner":"OlesiaKubska","description":"Teaching Load API (Backend) for managing teaching load. Built with TypeScript, Node.js, Express.js, MongoDB (Mongoose), JWT, Swagger. 🔗 Frontend repo: teaching-load-ui - https://github.com/OlesiaKubska/teaching-load-ui","archived":false,"fork":false,"pushed_at":"2025-09-15T07:10:04.000Z","size":143,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-15T09:13:49.608Z","etag":null,"topics":["backend","dotenv","expressjs","jwt-auth","jwt-authentication","jwt-token","mongodb","mongoose","nodejs","postman","swagger-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OlesiaKubska.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-21T10:33:24.000Z","updated_at":"2025-09-15T07:10:07.000Z","dependencies_parsed_at":"2025-08-21T13:14:27.511Z","dependency_job_id":"e05d1f5d-dd14-4076-b766-47ea202f0f13","html_url":"https://github.com/OlesiaKubska/teaching-load-api","commit_stats":null,"previous_names":["olesiakubska/teaching-load-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OlesiaKubska/teaching-load-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlesiaKubska%2Fteaching-load-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlesiaKubska%2Fteaching-load-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlesiaKubska%2Fteaching-load-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlesiaKubska%2Fteaching-load-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OlesiaKubska","download_url":"https://codeload.github.com/OlesiaKubska/teaching-load-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlesiaKubska%2Fteaching-load-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278722768,"owners_count":26034461,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","dotenv","expressjs","jwt-auth","jwt-authentication","jwt-token","mongodb","mongoose","nodejs","postman","swagger-api","typescript"],"created_at":"2025-10-07T04:52:57.472Z","updated_at":"2025-10-07T04:53:01.545Z","avatar_url":"https://github.com/OlesiaKubska.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Teaching Load API (Backend)\n\nBackend API for managing teaching load, built with **TypeScript**, **Express**, and **MongoDB (Mongoose)**.  \nThis project was migrated from JavaScript to TypeScript to ensure type safety and maintainability.\n\n---\n\n## 🚀 Features\n\n- Built with **Express.js** + **TypeScript**.\n- **MongoDB** connection via **Mongoose**.\n- Environment variables managed with **dotenv**.\n- Includes **Swagger** documentation (`/api/docs`).\n- Postman collection and environment available in `docs/postman/`.\n- CRUD operations for **Teachers**, **Subjects**, and **Loads**.\n- User authentication and authorization with **JWT**.\n- Passwords hashed with **bcrypt**.\n- Protected routes for Loads (`/api/loads`).\n\n---\n\n![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=flat\u0026logo=typescript\u0026logoColor=fff)\n![Node.js](https://img.shields.io/badge/Node.js-43853D?style=flat\u0026logo=node.js\u0026logoColor=white)\n![Express.js](https://img.shields.io/badge/Express.js-404D59?style=flat)\n![MongoDB](https://img.shields.io/badge/MongoDB-47A248?style=flat\u0026logo=mongodb\u0026logoColor=white)\n![JWT](https://img.shields.io/badge/JWT-black?style=flat\u0026logo=jsonwebtokens)\n\n---\n\n## 📦 Installation\n\nClone the repository and install dependencies:\n\n```bash\ngit clone https://github.com/OlesiaKubska/teaching-load-api.git\ncd teaching-load-api/backend\nnpm install\n```\n\n---\n\n## ⚙️ Configuration\n\nCreate a `.env` file in the `backend/` directory:\n\n```bash\nPORT=5000\nDB_URI=your_mongodb_connection_string\nDB_NAME=teaching_load\nJWT_SECRET=your_secret_key\n```\n\n---\n\n## 🛠️ Scripts\n\n```bash\n# Start in development mode (with auto-restart)\nnpm run dev\n\n# Build TypeScript to JavaScript\nnpm run build\n\n# Run compiled code\nnpm start\n\n# Seed database with sample data\nnpm run seed\n\n```\n\n---\n\n## 🌐 API Endpoints\n\n### Health Check\n\n```bash\nGET /api/health\n```\n\n### Response:\n\n```bash\n{\n  \"message\": \"Backend is running!\"\n}\n```\n\n---\n\n### Teachers:\n\n- GET /api/teachers # Get all teachers\n- GET /api/teachers/{id} # Get teacher by ID\n- POST /api/teachers # Create new teacher\n- PUT /api/teachers/{id} # Update teacher\n- DELETE /api/teachers/{id} # Delete teacher\n\n### Subjects\n\n- GET /api/subjects # Get all subjects\n- GET /api/subjects/{id} # Get subject by ID\n- POST /api/subjects # Create new subject\n- PUT /api/subjects/{id} # Update subject\n- DELETE /api/subjects/{id} # Delete subject\n\n### Loads\n\n- GET /api/loads # Get all loads\n- GET /api/loads/{id} # Get load by ID\n- POST /api/loads # Create new load\n- PUT /api/loads/{id} # Update load\n- DELETE /api/loads/{id} # Delete load\n\n### Auth\n\n- POST /api/auth/register   # Register new user\n- POST /api/auth/login      # Login and receive JWT\n\n---\n\n## 📊 API Documentation (Swagger)\n\nSwagger UI available at:\n\n```bash\nhttp://localhost:5000/api/docs\n\n```\n\n---\n\n## 🧩 Project Structure\n\n```bash\n\nbackend/\n│── docs/\n│   ├── seeds/\n│   │   ├── loads.json                  # Database seeding mechanism\n│   │   ├── subjects.json\n│   │   └── teachers.json\n│── src/\n│   ├── config/                         # Database configuration\n│   │   └── db.ts\n│   ├── controllers/                    # Route controllers\n│   │   ├── auth.controller.ts          # Auth endpoints\n│   │   ├── load.controller.ts\n│   │   ├── subject.controller.ts\n│   │   └── teacher.controller.ts\n│   ├── docs/                           # Swagger \u0026 Postman docs\n│   │   ├── postman/\n│   │   │   ├── TeachingLoad.postman_collection.json\n│   │   │   └── TeachingLoad.postman_environment.json\n│   │   └── swagger.ts\n│   ├── middlewares/                    # Express middlewares\n│   │   ├── authMiddleware.ts           # JWT validation\n│   │   ├── errorHandler.ts             # Errors\n│   │   ├── logger.ts                   # Logging\n│   │   └── validateRequest.ts          # Validation\n│   ├── models/                         # Mongoose models\n│   │   ├── user.model.ts               # User schema\n│   │   ├── load.model.ts\n│   │   ├── subject.model.ts\n│   │   └── teacher.model.ts\n│   ├── routes/                         # Express routes\n│   │   ├── auth.route.ts               # Auth routes\n│   │   ├── health.route.ts\n│   │   ├── load.route.ts\n│   │   ├── subject.route.ts\n│   │   └── teacher.route.ts\n│   ├── scripts/                        # Seed\n│   │   └── seed.ts\n│   ├── types/                          # Custom TypeScript interfaces\n│   │   ├── entities.ts\n│   │   └── env.d.ts\n│   ├── validations/                    # Validation\n│   │   ├── load.validation.ts\n│   │   ├── subject.validation.ts\n│   │   └── teacher.validation.ts\n│   │   └── user.validation.ts\n│   └── server.ts                       # App entry point\n│── .env                                # Environment variables\n│── package.json\n│── README.md\n└── tsconfig.json                       # TypeScript config\n\n```\n\n---\n\n## ✅ Acceptance Criteria\n\n- Server runs in TypeScript mode.\n\n- MongoDB successfully connects.\n\n- CRUD operations for Teacher, Subject, and Load are available.\n\n- Swagger docs available at `/api/docs`.\n\n- Postman collection available in `/docs/postman`.\n\n---\n\n## Postman collection\n\nTo test the API with Postman:\n\n1. Open Postman.\n2. Import collection: `docs/postman/TeachingLoad.postman_collection.json`\n3. Import environment: `docs/postman/TeachingLoad.postman_environment.json`\n4. Set the environment to **TeachingLoad Local**.\n5. Run CRUD requests for Teachers, Subjects, Loads, Auth → Register user, Login user.\n\n---\n\n## 🌱 Database Seeding\n\nThis project includes a seeding script to quickly populate MongoDB with initial data for testing.\n\n### Run the seed script:\n\n```bash\nnpm run seed\n```\n\n---\n\n## 👩‍💻 Author\nProject developed by **Olesia Kubska**\n\n📌 GitHub: [OlesiaKubska](https://github.com/OlesiaKubska)\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folesiakubska%2Fteaching-load-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folesiakubska%2Fteaching-load-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folesiakubska%2Fteaching-load-api/lists"}