Skip to content

Commit 36fd33d

Browse files
committed
Update README.md with comprehensive project description and quick start guide; add Flowboard screenshot
1 parent bd7dfcc commit 36fd33d

2 files changed

Lines changed: 64 additions & 4 deletions

File tree

README.md

Lines changed: 64 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,69 @@
11
# Flowboard — Project Management System
22

3-
Flowboard is a project management system created using React and .NET Web API, utilizing Fluent UI components.
3+
A comprehensive project management solution designed to streamline workflow and team collaboration. Features include interactive kanban boards, real-time task updates, and robust user management. The frontend uses TypeScript and Fluent UI components; the backend uses ASP.NET Core and MongoDB.
44

5-
## Quick overview
5+
![Flowboard screenshot](src/assets/flowboard1.webp)
66

7-
- Framework: React 19 + TypeScript
7+
8+
9+
---
10+
11+
## Quick overview ✅
12+
13+
- Frontend: React 19 + TypeScript
814
- Bundler / dev server: Vite
9-
- UI components: Fluent UI React (@fluentui/react-components)
15+
- UI library: Fluent UI React (`@fluentui/react-components`)
16+
- HTTP client: Axios
17+
- Forms: react-hook-form
18+
19+
---
20+
21+
## Requirements 💡
22+
23+
- Node.js 24
24+
- Yarn
25+
- .NET 9.0 SDK (if you want to run the backend)
26+
- MongoDB (for running the backend locally or use a hosted cluster)
27+
28+
---
29+
30+
## Frontend — Quick start (yarn) 🔧
31+
32+
1. Install dependencies:
33+
34+
```bash
35+
yarn install
36+
```
37+
38+
2. Create a `.env` in the frontend root if you need to override the API base URL (optional):
39+
40+
```
41+
VITE_API_BASE_URL=http://localhost:5158
42+
```
43+
44+
3. Start the dev server:
45+
46+
```bash
47+
yarn dev
48+
```
49+
50+
4. Useful scripts (from `package.json`):
51+
52+
- `yarn dev` — start Vite dev server
53+
- `yarn build` — build production bundle
54+
- `yarn preview` — preview production build locally
55+
- `yarn lint` — run ESLint
56+
57+
The app runs by default at `http://localhost:5173` when `yarn dev` is used.
58+
59+
---
60+
61+
62+
## Contributing ✨
63+
64+
- Follow existing code patterns (Fluent UI `makeStyles`, service API modules, strict TypeScript).
65+
- Open an issue or submit a PR for features or bug fixes.
66+
67+
---
68+
69+
If you'd like, I can also add more detailed setup for testing, a Docker compose file for local DB, or example environment files. Let me know which you'd prefer next. ✅

src/assets/flowboard1.webp

72.6 KB
Loading

0 commit comments

Comments
 (0)