Home

Welcome to the MinBan API Documentation!

MinBan is a minimal Kanban application designed to help you manage tasks for your projects efficiently. The backend is powered by Go with the Gin framework, offering a fast and lightweight API to handle all your Kanban-related needs.

Table of Contents

• Installation: Set up MinBan locally.
• Docker Setup
• Source Setup
• API Routes:
• Authentication: Learn how to authenticate with the API and perform login, logout, and session checks.
  • Login
  • Logout
  • Check Auth
• Card: Manage cards within a project.
  • Get Cards
  • Create Card
  • Update Card
  • Delete Card
• State: Manage task states (or columns).
  • Get States
  • Create State
  • Update State
  • Delete State
• Tag: Manage tags for tasks.
  • Get Tags
  • Create Tag
  • Update Tag
  • Delete Tag
• Database: Overview of MinBan's SQLite database schema and relationships.

Technologies

The backend leverages:

• Go: Efficient and high-performance backend language.
• Gin Framework: A fast and simple web framework for building APIs.
• SQLite: A lightweight database system for storing data locally.
• JWT Authentication: For securing user access.

Contribution

MinBan is an open-source project. Contributions are always welcome! Feel free to submit issues or pull requests on the GitHub repository.