Bio Project Management

English | 中文说明

Bio Project Management is a modular project management, knowledge base, CRM, form, notification, and reporting platform for bio-organic fertilizer companies. The first release focuses on single-company internal operations, username/password login, role-based permissions, project-task collaboration, local attachments, and multiple deployment options.

Features

• Slack-style workspace UI built with Vue 3, Element Plus, and Vite.
• Account/password authentication with JWT, user profiles, avatars, language preferences, roles, and direct user permissions.
• Admin console for users, roles, permissions, translation dictionary, tags, and form management.
• Project management with owners, participants, comments, notes, approvals, task-linked progress calculation, and in-app mention notifications.
• Task management with personal task views, all-task views, project synchronization, status updates, progress notes, and second-confirm deletion.
• In-app notifications and communication threads with unread counts, read state, mentions, @all, and Ctrl + Enter quick reply.
• Knowledge base with folder-style categories, tags, permissions, rich-text editing, Markdown interoperability, images, and attachments.
• Dynamic form module that can design reusable forms, publish fields to reports or dashboards, and power the CRM module.
• CRM records driven by the first built-in CRM form, including customer details, tracking users, follow-up content, and detail views.
• Global search across projects, tasks, knowledge articles, and CRM customers.
• PostgreSQL and Redis production architecture, with a SQL.js standalone mode for direct server debugging and demos.

Architecture

Frontend: Vue 3 + Element Plus + Vite
  - Routes: /dashboard, /project, /task, /knowledge, /crm, /report, /admin
  - Workspace shell, kanban/list views, forms, charts, i18n dictionary, global search

Backend: Node.js + NestJS REST API
  - Modules: Auth, User, Role, Translation, Project, Task, Notification,
             Communication, Knowledge, Form, CRM, Report, Search
  - Services: permission checks, mention parsing, notification dispatch,
              file upload, scheduled-ready data model

Data layer:
  - PostgreSQL: users, roles, projects, tasks, knowledge, CRM, forms, reports
  - Redis: cache/session/queue-ready service layer
  - SQL.js: local standalone debug database
  - Local filesystem: uploads and attachments

Repository Layout

backend/              NestJS API service
frontend/             Vue 3 workspace UI and nginx config
infra/postgres/       PostgreSQL initialization files
scripts/              Windows standalone start/stop scripts
docs/                 Architecture and deployment notes
docker-compose.yml    PostgreSQL, Redis, backend, and frontend stack
docker-compose.portainer.yml
                      Portainer-ready stack file
docker-compose.openmediavault.yml
                      OpenMediaVault Compose plugin stack file

Quick Start

npm.cmd install
npm.cmd run dev

Default local URLs:

• Frontend: http://localhost:5173
• Backend API: http://localhost:3333/api

Default first admin account:

• Email: admin@bio.local
• Password: Admin123456

Change JWT_SECRET and the default admin password before production use.

Server Deployment

This mode runs directly on a Windows or Linux server without Docker. Use it for debugging, demonstrations, or small internal deployments.

Option A: Standalone Debug Mode

Standalone mode uses SQL.js and local files, so it does not require PostgreSQL or Redis.

Copy-Item .env.standalone.example .env.standalone
powershell -ExecutionPolicy Bypass -File .\scripts\start-standalone.ps1

Open http://127.0.0.1:5173/.

Stop the services:

powershell -ExecutionPolicy Bypass -File .\scripts\stop-standalone.ps1

Standalone data paths:

• Database: data/standalone.sqlite
• Uploads: uploads/
• Logs: logs/

Option B: Host Services Mode

Use this mode when PostgreSQL and Redis are installed on the server.

1. Install Node.js 22 LTS or newer, PostgreSQL 16+, Redis 7+, and npm.

2. Create the database and user:

   CREATE DATABASE bio_pm;
   CREATE USER bio_pm WITH PASSWORD 'replace_with_a_strong_password';
   GRANT ALL PRIVILEGES ON DATABASE bio_pm TO bio_pm;

3. Copy and edit environment variables:

   Copy-Item .env.example .env

4. Install dependencies and build:

   npm.cmd install
   npm.cmd run build

5. Start the backend:

   npm.cmd --workspace backend run start

6. Serve frontend/dist with nginx, Caddy, IIS, or another static server, and proxy /api to http://127.0.0.1:3333/api.

Recommended production settings:

• Use a strong JWT_SECRET.
• Set strong PostgreSQL and Redis passwords.
• Back up PostgreSQL and the upload directory.
• Put the frontend behind HTTPS.
• Store uploads on persistent disk or object storage.

Docker Deployment

Docker Direct Deployment

Use this when you want to run containers manually instead of Docker Compose.

Create a Docker network:

docker network create bio-pm-net

Start PostgreSQL:

docker run -d --name bio-pm-postgres --network bio-pm-net \
  -e POSTGRES_DB=bio_pm \
  -e POSTGRES_USER=bio_pm \
  -e POSTGRES_PASSWORD=bio_pm_password \
  -v bio_pm_postgres:/var/lib/postgresql/data \
  -p 5432:5432 \
  postgres:16-alpine

Start Redis:

docker run -d --name bio-pm-redis --network bio-pm-net \
  -p 6379:6379 \
  redis:7-alpine

Build and run the backend:

docker build -t bio-pm-backend ./backend
docker run -d --name bio-pm-backend --network bio-pm-net \
  --env-file .env \
  -e DATABASE_HOST=bio-pm-postgres \
  -e DATABASE_PORT=5432 \
  -e DATABASE_USER=bio_pm \
  -e DATABASE_PASSWORD=bio_pm_password \
  -e DATABASE_NAME=bio_pm \
  -e REDIS_HOST=bio-pm-redis \
  -e REDIS_PORT=6379 \
  -v bio_pm_uploads:/app/uploads \
  -e PORT=3333 \
  -p 3333:3333 \
  bio-pm-backend

Build and run the frontend:

docker build -t bio-pm-frontend ./frontend
docker run -d --name bio-pm-frontend --network bio-pm-net \
  -p 5173:80 \
  bio-pm-frontend

Open http://localhost:5173.

Docker Compose Deployment

Docker Compose is the recommended container deployment path.

cp .env.example .env
docker compose up -d --build

Services:

• Frontend: http://localhost:5173
• Backend API: http://localhost:3333/api
• PostgreSQL: localhost:5432
• Redis: localhost:6379

Stop the stack:

docker compose down

Stop and remove persistent volumes:

docker compose down -v

Portainer Stack Deployment

Use docker-compose.portainer.yml when deploying from Portainer.

Recommended Portainer flow:

1. Open Portainer and go to Stacks.

2. Create a new stack, for example bio-project-management.

3. Choose Repository as the build method.

4. Repository URL: https://github.com/starboykm/Bio_Project_Management.git

5. Compose path: docker-compose.portainer.yml

6. Set these stack environment variables before deploying:

   POSTGRES_DB=bio_pm
   POSTGRES_USER=bio_pm
   POSTGRES_PASSWORD=replace_with_a_strong_password
   JWT_SECRET=replace_with_a_long_random_secret
   ADMIN_EMAIL=admin@bio.local
   ADMIN_PASSWORD=replace_with_a_strong_admin_password
   FRONTEND_PORT=5173
   BACKEND_PORT=3333

7. Deploy the stack and open http://SERVER_IP:5173.

The Portainer compose file builds the backend and frontend images from this repository. The generated local image names are:

• bio-project-management-backend:0.1.2
• bio-project-management-frontend:0.1.2

Pull and deploy from a server without Portainer:

git clone https://github.com/starboykm/Bio_Project_Management.git
cd Bio_Project_Management
cp .env.example .env
docker compose -f docker-compose.portainer.yml up -d --build

Check service status:

docker compose -f docker-compose.portainer.yml ps

View logs:

docker compose -f docker-compose.portainer.yml logs -f backend frontend

OpenMediaVault Compose Plugin Deployment

Use docker-compose.openmediavault.yml when deploying from the OpenMediaVault Compose plugin. This file pulls prebuilt application images from Docker Hub and does not build source code on the OMV server.

Before deploying, build and push the two application images to your Docker Hub namespace:

docker login

docker build -t siriuswang83/bio-project-management-backend:0.1.2 -t siriuswang83/bio-project-management-backend:latest ./backend
docker build -t siriuswang83/bio-project-management-frontend:0.1.2 -t siriuswang83/bio-project-management-frontend:latest ./frontend

docker push siriuswang83/bio-project-management-backend:0.1.2
docker push siriuswang83/bio-project-management-backend:latest
docker push siriuswang83/bio-project-management-frontend:0.1.2
docker push siriuswang83/bio-project-management-frontend:latest

You can also publish images from GitHub Actions. Add repository secrets DOCKERHUB_USERNAME and DOCKERHUB_TOKEN, then run the Publish Docker Hub Images workflow with version 0.1.2.

Pull the images manually if needed:

docker pull siriuswang83/bio-project-management-backend:0.1.2
docker pull siriuswang83/bio-project-management-frontend:0.1.2

In OMV Compose plugin, create a compose file from docker-compose.openmediavault.yml and set:

DOCKERHUB_NAMESPACE=siriuswang83
APP_VERSION=0.1.2
POSTGRES_DB=bio_pm
POSTGRES_USER=bio_pm
POSTGRES_PASSWORD=replace_with_a_strong_password
JWT_SECRET=replace_with_a_long_random_secret
ADMIN_EMAIL=admin@bio.local
ADMIN_PASSWORD=replace_with_a_strong_admin_password
FRONTEND_PORT=5173
BACKEND_PORT=3333

Open http://OMV_SERVER_IP:5173 after deployment. Backend API is available at http://OMV_SERVER_IP:3333/api.

See OpenMediaVault deployment guide for the full deployment plan.

Note: the backend listens on port 3333 in Docker deployments because port 3000 is often occupied on NAS servers.

Release

The first release is tagged as v0.1.2.

See Release Notes.