Skip to content

Magic Scrum is a simple and extensible NestJS-based REST API designed for managing tasks in a Scrum workflow. It provides basic CRUD operations for core resources such as tasks, users, and sprints, making it ideal for small teams or as a boilerplate for more advanced project management tools.

Notifications You must be signed in to change notification settings

msi404/magic-scrum-api

Repository files navigation

πŸͺ„ Magic Scrum – Task Management API

Magic Scrum is a lightweight and modular NestJS REST API for managing tasks in a Scrum workflow. It’s perfect for small teams, learning purposes, or as a starting point for building a full-featured project management tool.


πŸš€ Features

  • πŸ“‹ CRUD operations for tasks, users, and sprints
  • πŸ” Scrum-style task lifecycle: Backlog β†’ In Progress β†’ Done
  • 🧱 Modular architecture following NestJS best practices
  • πŸ’Ύ Uses SQLite for quick setup and local development
  • βš™οΈ Powered by TypeORM for object-relational mapping
  • βœ… Input validation with class-validator
  • πŸ§ͺ Ready for unit testing with Jest

🧰 Tech Stack

Layer Technology
Framework NestJS
Database SQLite
ORM TypeORM
Validation class-validator
Testing Jest

πŸ“¦ Getting Started

1. Clone the repository

git clone https://github.com/msi404/magic-scrum-api.git
cd magic-scrum-api

2. Install dependencies

npm install

3. Run the development server

npm run start:dev

By default, the app uses an SQLite database stored in data/sqlite.db.


πŸ“ Project Structure

src/
β”œβ”€β”€ app.module.ts
β”œβ”€β”€ tasks/
β”‚   β”œβ”€β”€ task.controller.ts
β”‚   β”œβ”€β”€ task.service.ts
β”‚   β”œβ”€β”€ task.entity.ts
β”‚   └── dto/
β”‚       └── create-task.dto.ts

πŸ§ͺ Running Tests

npm run test

πŸ“˜ API Docs

If you'd like to add Swagger documentation:

npm install --save @nestjs/swagger swagger-ui-express

Then configure it in your main.ts.


πŸ“ License

MIT – feel free to use, modify, and contribute!


πŸ’‘ Contributions Welcome

Found a bug or have a feature idea? Open an issue or submit a PR!

About

Magic Scrum is a simple and extensible NestJS-based REST API designed for managing tasks in a Scrum workflow. It provides basic CRUD operations for core resources such as tasks, users, and sprints, making it ideal for small teams or as a boilerplate for more advanced project management tools.

Topics

Resources

Stars

Watchers

Forks