README.md

Dolphin Admin Server

English / 简体中文

Dolphin Admin Server is the backend service of Dolphin Admin Web, based on Express + TypeScript + Prisma + PostgresSQL, built with EST.

Features

• Build Web service based on Express
• TypeScript, of course
• Prisma as ORM
• PostgreSQL as relational database
• MongoDB as non-relational database
• Build routes, middleware, exception handling, etc. based on decorators
• JWT authentication and role-based authorization
• Build file service based on multer
• Real-time communication using Socket.IO
• Code check with ESLint
• Code formatting with Prettier
• Code spelling check with CSpell
• Git commit management with Husky, lint-staged, commitlint, cz-git
• Support absolute path import, use @/*

TODO

• Containerization with Docker and Docker Compose

Tech Stack

• Express
• TypeScript
• Prisma
• PostgreSQL
• MongoDB

Code Style

• Airbnb JavaScript Style Guide
• Dev Standard

Usage

Environment

• Node.js >=16.14.0
• pnpm
• PostgreSQL

Configuration Environment Variables

Configure .env file, refer to .env.example.

Install

pnpm i

Database Migration

pnpm prisma:migrate:dev
pnpm prisma:migrate:mongo
pnpm prisma:generate

Run

pnpm dev

Build

pnpm build

License

MIT License © 2023 Bruce Song from Bit Ocean