|
| 1 | +# Flowboard Backend (ASP.NET Core 9) ✅ |
| 2 | + |
| 3 | +## Overview |
| 4 | +A simple REST API backend for Flowboard — a project management system built with ASP.NET Core 9 and MongoDB. It provides authentication (JWT), user/project/task management, analytics, and an OpenAPI interface for development. |
| 5 | + |
| 6 | +## Quick Start 🔧 |
| 7 | +1. Copy or create a `.env` file in the backend folder (an example `.env` is already included). |
| 8 | +2. Ensure you have the .NET 9 SDK installed. |
| 9 | +3. Run the API: |
| 10 | + |
| 11 | +```bash |
| 12 | +cd Flowboard-Project-Management-System-Backend |
| 13 | +dotnet restore |
| 14 | +dotnet run |
| 15 | +``` |
| 16 | + |
| 17 | +Or use the workspace task: `Run All` or the `Backend: dev` task. |
| 18 | + |
| 19 | +The app reads environment variables from `.env` (via DotNetEnv). HTTPS port and other settings can be set there (the repository example uses `ASPNETCORE_HTTPS_PORT=7076`). |
| 20 | + |
| 21 | + |
| 22 | +## API Documentation & Examples |
| 23 | +See `Apis.http` in this folder for example API requests and documentation. You can use this file with VS Code REST Client or similar tools to test endpoints quickly. |
| 24 | + |
| 25 | + |
| 26 | +## Key Dependencies (from `*.csproj`) 📦 |
| 27 | +- `BCrypt.Net-Next` — password hashing |
| 28 | +- `DotNetEnv` — loads `.env` files into environment variables |
| 29 | +- `Microsoft.AspNetCore.Authentication.JwtBearer` — JWT authentication |
| 30 | +- `Microsoft.AspNetCore.OpenApi` — OpenAPI integration for development |
| 31 | +- `MongoDB.Driver` — MongoDB client |
| 32 | +- `System.IdentityModel.Tokens.Jwt` — JWT token handling |
| 33 | + |
| 34 | +These are added in `Flowboard-Project-Management-System-Backend.csproj`. |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## OpenAPI / Development UI |
| 39 | +OpenAPI is enabled in development (`Program.cs` uses `AddOpenApi()` and `MapOpenApi()`). You can view the generated OpenAPI docs during development. |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +## Contributing |
| 44 | +Feel free to open issues or create PRs to improve the API, add tests, or harden security (rate-limiting, stronger validation, roles, etc.). |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +Made for Flowboard — lightweight project management API. 🚀 |
0 commit comments