Skip to content

Commit 7e03cb0

Browse files
committed
Revise and expand README with detailed feature list
Updated the README to provide a more comprehensive overview of platform features, including detailed sections for dashboard, projects, meetings, productivity tools, AI assistant, resume editor, chat, wiki, files, diagrams, entertainment, staff portal, and settings. Improved clarity on multilingual support, updated tech stack details, and expanded the directory structure and command descriptions for better onboarding.
1 parent 8cba1ce commit 7e03cb0

1 file changed

Lines changed: 140 additions & 32 deletions

File tree

README.md

Lines changed: 140 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@
55
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)](https://www.typescriptlang.org/)
66
[![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-3.4-38B2AC)](https://tailwindcss.com/)
77
[![Supabase](https://img.shields.io/badge/Supabase-Database-3ECF8E)](https://supabase.com/)
8-
[![Sponsor](https://img.shields.io/badge/♥_Sponsor-Support_Us-fe8184)](https://github.com/sponsors/lab68dev)
8+
[![Sponsor](https://img.shields.io/badge/%E2%99%A5_Sponsor-Support_Us-fe8184)](https://github.com/sponsors/lab68dev)
99

10-
**Lab68 Dev Platform** is a comprehensive collaborative product development workspace with integrated staff management.
11-
It provides dashboards for planning, documentation, meetings, AI-assisted workflows, role-aware access controls, live customer support, and a complete staff portal — built with **Next.js App Router**, **TypeScript**, and a modular component system.
10+
**Lab68 Dev Platform** is a comprehensive collaborative product development workspace with integrated staff management. It provides dashboards for planning, documentation, meetings, AI-assisted workflows, role-aware access controls, live customer support, and a complete staff portal — built with **Next.js App Router**, **TypeScript**, and a modular component system.
1211

1312
---
1413

@@ -19,8 +18,8 @@ It provides dashboards for planning, documentation, meetings, AI-assisted workfl
1918
- **Staff Management Portal** – dedicated staff authentication, user management, support queue, analytics dashboard, and approval workflows.
2019
- **Live Customer Support** – real-time chat widget with staff dashboard for 24/7 support management.
2120
- **Supabase Backend** – PostgreSQL database with Row-Level Security (RLS), indexed queries, and automatic session cleanup.
22-
- **Multilingual UI** – centralized translation registry covering nine locales with automatic English fallbacks.
23-
- **Productivity Surface** – dashboards for projects, kanban, meetings, files, wiki, diagrams, community discussions, and AI tools.
21+
- **Multilingual UI** – centralized translation registry with English and Vietnamese support.
22+
- **Productivity Suite** – dashboards for projects, kanban, meetings, files, wiki, diagrams, community discussions, and AI tools.
2423
- **Theme & Layout Framework** – dark/light theme support, sidebar navigation, reusable UI primitives, and responsive Tailwind styling.
2524

2625
---
@@ -37,45 +36,135 @@ It provides dashboards for planning, documentation, meetings, AI-assisted workfl
3736
| AI Models | Ollama (local) - Privacy-first, no API costs |
3837
| Email | Nodemailer with SMTP |
3938
| Security | Rate limiting, session management, activity logging |
40-
| Styling | Tailwind CSS + custom utility components |
39+
| Styling | Tailwind CSS + Radix UI components |
4140
| Package Manager | pnpm |
4241

4342
---
4443

4544
## Features
4645

46+
### Dashboard
47+
48+
The main dashboard (`/dashboard`) provides an overview of your workspace with:
49+
50+
- **Quick Stats** – Projects, tasks, meetings, and activity metrics
51+
- **Calendar Widget** – Upcoming meetings with visual indicators
52+
- **Recent Activity** – Latest actions across your workspace
53+
- **Weather Widget** – Current weather conditions
54+
- **Meeting Reminders** – Configurable notifications with browser/sound alerts
55+
56+
### Projects & Kanban
57+
58+
Create projects, assign collaborators, manage roles, and track work:
59+
60+
- **Issue Tracking** – Create, assign, and manage issues with labels and sprints
61+
- **Kanban Boards** – Drag-and-drop task management
62+
- **Collaborators** – Invite team members with role-based permissions
63+
- **Activity Logging** – Track all project changes
64+
65+
### Meeting Management
66+
67+
Schedule and manage meetings (`/dashboard/meeting`):
68+
69+
- **Meeting Scheduler** – Create meetings with date, time, and duration
70+
- **Smart Reminders** – Configurable alerts (5, 10, 15, 30, 60 min before)
71+
- **Browser Notifications** – System-level alerts when permitted
72+
- **Sound Alerts** – Audio notifications with volume control
73+
- **Snooze Functionality** – 5-minute snooze on reminders
74+
75+
### Todo & Pomodoro
76+
77+
Task management with productivity tools (`/dashboard/todo`):
78+
79+
- **Task Management** – Create, prioritize, and complete tasks
80+
- **Pomodoro Timer** – Focus timer with work/break cycles
81+
- **Visual Coffee Cup** – Animated progress indicator
82+
- **Lofi Music Integration** – Focus music player
83+
- **Session Tracking** – Daily goal progress
84+
4785
### AI Tools
4886

49-
The AI Tools feature (`/dashboard/ai-tools`) provides an intelligent development assistant with RAG (Retrieval-Augmented Generation).
87+
Intelligent development assistant (`/dashboard/ai-tools`):
5088

51-
- **RAG-Enhanced AI** – AI powered by your documentation and codebase.
52-
- **Privacy First** – All processing stays on your infrastructure (Ollama + Supabase pgvector).
53-
- **Cost Free** – Local Ollama models mean zero API fees.
54-
- **Modern Chat UI** – Complete chat interface with history and code highlighting.
89+
- **RAG-Enhanced AI** – AI powered by your documentation and codebase
90+
- **Privacy First** – All processing stays on your infrastructure (Ollama)
91+
- **Cost Free** – Local Ollama models mean zero API fees
92+
- **Modern Chat UI** – Complete chat interface with history and code highlighting
5593

5694
### Resume Editor
5795

58-
The Live Resume Editor (`/dashboard/resume`) is a WYSIWYG resume builder.
96+
WYSIWYG resume builder (`/dashboard/resume`):
5997

60-
- **Live Preview** – A4 paper format with instant updates.
61-
- **Customization** – Fonts, colors, and 5 professional templates.
62-
- **Data Persistence** – Auto-saves to local storage.
98+
- **Live Preview** – A4 paper format with instant updates
99+
- **Customization** – Fonts, colors, and professional templates
100+
- **PDF Export** – Download your resume as PDF
101+
- **Data Persistence** – Auto-saves to local storage
63102

64-
### Staff Portal
103+
### Chat & Messaging
65104

66-
Full admin interface at `/staff/dashboard` with user management, analytics, activity logging, and role-based access control.
105+
Real-time messaging (`/dashboard/chat`):
67106

68-
### Projects & Kanban
107+
- **Direct Messages** – One-on-one conversations
108+
- **Group Chats** – Team communication
109+
- **Online Presence** – See who's online
110+
- **Typing Indicators** – Real-time feedback
111+
- **Message Reactions** – Emoji reactions on messages
69112

70-
Create projects, assign collaborators, manage roles, and track work with Kanban boards.
113+
### Wiki & Documentation
71114

72-
### Chat & Messaging
115+
Knowledge base (`/dashboard/wiki`):
116+
117+
- **Article Management** – Create and organize documentation
118+
- **Category Support** – Organize articles by topic
119+
- **Search** – Find articles quickly
120+
121+
### Files & Storage
122+
123+
File management (`/dashboard/files`):
124+
125+
- **File Upload** – Upload and organize files
126+
- **Category Filtering** – Filter by file type
127+
- **Project Association** – Link files to projects
128+
129+
### Diagrams & Whiteboard
130+
131+
Visual collaboration tools:
132+
133+
- **Flowcharts** – Create flow diagrams
134+
- **Mermaid Support** – Text-to-diagram rendering
135+
- **Whiteboard** – Freeform drawing canvas
136+
137+
### Entertainment
138+
139+
Brain games and relaxation (`/dashboard/entertainment`):
140+
141+
- **Tetris** – Classic block puzzle game
142+
- **Snake** – Classic snake game
143+
- **Sudoku** – Number puzzle
144+
- **Typing Game** – Speed typing practice
145+
- **Math Sprint** – Quick math challenges
146+
- **Word Scramble** – Word puzzle game
147+
- **Sliding Puzzle** – Tile sliding puzzle
148+
149+
### Staff Portal
150+
151+
Full admin interface (`/staff/dashboard`):
152+
153+
- **User Management** – Manage platform users
154+
- **Analytics Dashboard** – Usage statistics
155+
- **Activity Logging** – Track all staff actions
156+
- **Role-Based Access** – Admin privileges
157+
- **Support Queue** – Manage customer support tickets
73158

74-
Real-time messaging with Socket.io, supporting direct messages, group chats, online presence, and typing indicators.
159+
### Settings
75160

76-
### Whiteboard
161+
User preferences (`/dashboard/settings`):
77162

78-
Collaborative drawing canvas with shapes, text, and export capabilities.
163+
- **Profile Management** – Update name, bio, avatar
164+
- **Language Settings** – English/Vietnamese
165+
- **Notification Preferences** – Configure meeting reminders
166+
- **Theme Selection** – Dark/light mode
167+
- **Security Settings** – Password management
79168

80169
---
81170

@@ -96,7 +185,7 @@ pnpm install
96185

97186
### Quick Setup
98187

99-
1. **Database**: Create a Supabase project and run `supabase-staff-schema.sql`.
188+
1. **Database**: Create a Supabase project and run the schema migrations.
100189
2. **Environment**: Copy `.env.example` to `.env.local` and fill in your Supabase credentials and JWT secret.
101190

102191
```bash
@@ -127,11 +216,29 @@ Visit [http://localhost:3000](http://localhost:3000).
127216
```text
128217
lab68dev-platform/
129218
├── app/ # Route groups and feature areas
130-
├── components/ # Reusable UI atoms/molecules
131-
├── lib/ # Domain logic (auth, email, i18n, team)
132-
├── docs/ # Comprehensive documentation
219+
│ ├── api/ # API routes
220+
│ ├── dashboard/ # Main dashboard features
221+
│ │ ├── ai-tools/ # AI assistant
222+
│ │ ├── chat/ # Real-time messaging
223+
│ │ ├── community/ # Discussions
224+
│ │ ├── diagrams/ # Flow diagrams
225+
│ │ ├── entertainment/ # Games
226+
│ │ ├── files/ # File management
227+
│ │ ├── meeting/ # Meeting scheduler
228+
│ │ ├── planning/ # Sprint planning
229+
│ │ ├── projects/ # Project management
230+
│ │ ├── resume/ # Resume builder
231+
│ │ ├── settings/ # User settings
232+
│ │ ├── support/ # Customer support
233+
│ │ ├── todo/ # Task management
234+
│ │ ├── whiteboard/ # Drawing canvas
235+
│ │ └── wiki/ # Documentation
236+
│ └── staff/ # Staff portal
237+
├── components/ # Reusable UI components
238+
├── lib/ # Domain logic (auth, email, i18n, database)
239+
├── docs/ # Documentation
133240
├── public/ # Static assets
134-
└── scripts/ # Utilities
241+
└── scripts/ # Utility scripts
135242
```
136243

137244
---
@@ -140,10 +247,11 @@ lab68dev-platform/
140247

141248
| Command | Description |
142249
| --- | --- |
143-
| `pnpm dev` | Start the development server. |
144-
| `pnpm build` | Compile the production build. |
145-
| `pnpm start` | Serve the production build. |
146-
| `pnpm lint` | Run ESLint. |
250+
| `pnpm dev` | Start the development server with Socket.io |
251+
| `pnpm dev:next` | Start Next.js dev server only |
252+
| `pnpm build` | Compile the production build |
253+
| `pnpm start` | Serve the production build |
254+
| `pnpm lint` | Run ESLint |
147255

148256
---
149257

0 commit comments

Comments
 (0)