Pengtoshi Boilerplate

TS-based boilerplate for development including client, server, and shared libraries.

🛠 Tech Stack

This boilerplate is built with NX, a smart, fast and extensible build system with first class monorepo support and powerful integrations.

Common
Repository & Styling
Applications
UI & Design
Database & ORM

📁 Folder Structure

📁 pengtoshi-boilerplate
├── 📁 apps
│   ├── 📁 client-next        # Next.js client app example
│   ├── 📁 server-nest        # NestJS server app example
│   └── 📁 server-nest-e2e    # E2E tests for NestJS server
├── 📁 libs                   # Shared libraries
├── 📁 tools                  # Tools for development
└── 📁 docs                   # Documentation

🚀 Getting Started

Installation

yarn install

Start Applications

Start all applications in development mode:

yarn start:all

Only for the first time: This command will start the docker containers first, run the migrations, and start the applications. After that, you can start the applications by running yarn start:all.

yarn docker:up
yarn db-migrate:dev
yarn start:all

Start a specific application:

yarn start <app-name>

Testing

Run all tests:

yarn test:all

Run tests for a specific application:

yarn test <app-name>

Linting

Run linting for all applications:

yarn lint:all

Run linting for a specific application:

yarn lint <app-name>

Database

Generates Prisma Client and synchronizes the database schema:

yarn prepare:prisma

Run database migrations:

yarn db-migrate:dev

Storybook

Start Storybook:

yarn storybook

Build only:

yarn build-storybook