Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devaungphyo/next-nest-pg
Turborepo with NextJS and NestJS, Postgresql with TypeORM. UI components for shadcnUI pre configured.
https://github.com/devaungphyo/next-nest-pg
nestjs nextjs postgresql shadcn-ui turborepo typeorm
Last synced: 18 days ago
JSON representation
Turborepo with NextJS and NestJS, Postgresql with TypeORM. UI components for shadcnUI pre configured.
- Host: GitHub
- URL: https://github.com/devaungphyo/next-nest-pg
- Owner: devaungphyo
- License: mit
- Created: 2024-09-30T14:52:43.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T17:25:57.000Z (22 days ago)
- Last Synced: 2024-12-02T18:34:06.075Z (22 days ago)
- Topics: nestjs, nextjs, postgresql, shadcn-ui, turborepo, typeorm
- Language: TypeScript
- Homepage:
- Size: 1.08 MB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## NestJS Boilerplate with Turborepo
This repository provides a scalable and efficient monorepo setup using Turborepo. It includes NestJS for backend
services and NextJS for frontend applications, with a suite of tools and libraries configured for seamless development
and deployment.
### **Features**
1. [X] NestJS backend
2. [X] NextJS (v15) frontend
1. [x] SWC for fast TypeScript and JavaScript transpilation
2. [x] pnpm for efficient dependency management
3. [x] JWT Access Token & Refresh Token Authentication for secure API access
4. [x] PostgreSQL database with TypeORM
5. [x] Nodemailer for email services
6. [x] Linting and Formatting pre-configured for code quality
7. [x] Micro-Frontend Support with Turborepo
8. [x] Shadcn/UI integration for styled components
### **Table of Contents**
- Installation
- Getting Started
- Project Structure
- Scripts
- Contributing
- License
### **Installation**
Clone the repository:
```shell
git clone https://github.com/devaungphyo/turborepo.git
```
Navigate to the project directory:
```shell
cd turborepo
```
Install dependencies using pnpm:
```shell
pnpm install
```
Getting Started
To start the development server, run:
```shell
pnpm dev
```
This will start both the NestJS backend and the Next.js frontend in development mode.
Project Structure
The repository is organized into the following structure:
```yaml
turborepo/
├── apps
│ ├── api # NestJS application
│ └── web # NextJS application
├── packages
│ ├── ui # shadcn/UI component library
│ ├── ts-config # Shared typescript configuration files
│ ├── eslint-config # Shared eslint configuration files
│ └── utils # Shared utility functions
└── turbo.json # Turborepo configuration
```
### Backend (NestJS)
The backend is powered by NestJS, with TypeORM configured to use PostgreSQL. JWT access token and refresh token
authentication is implemented for secure API access. Nodemailer is used to handle email services.
[Backend Documentation](apps/api/README.md)
### Frontend (NextJS)
The frontend is built with NextJS v15, styled with shadcn/UI components. It is optimized for server-side rendering and
frontend authentication.
Micro-Frontend with Turborepo
Using Turborepo, the project supports a micro-frontend architecture, enabling shared libraries and configurations across
apps.
[Frontend Documentation](apps/web/README.md)
### Scripts
- **pnpm add:api** - Adds a package specifically to the api workspace.
- **pnpm add:web** - Adds a package specifically to the web workspace.
- **pnpm build** - Builds both the backend and frontend for production using TurboRepo.
- **pnpm changeset** - Creates a new changeset for versioning updates.
- **pnpm clear:modules** - Clears all node_modules in the project using npkill.
- **pnpm commit** - Opens an interactive commit message interface using Commitizen (cz).
- **pnpm dev** - Starts both the backend and frontend in development mode using TurboRepo.
- **pnpm dev:api** - Starts the backend (api) in development mode.
- **pnpm dev:web** - Starts the frontend (web) in development mode.
- **pnpm format** - Formats the codebase according to the pre-configured Prettier rules.
- **pnpm format:check** - Checks the codebase formatting against Prettier rules without modifying files.
- **pnpm lint** - Lints all code in the repository using TurboRepo.
- **pnpm prepare** - Runs Husky to set up Git hooks.
- **pnpm prod** - Starts both the backend and frontend in production mode.
- **pnpm test** - Runs all tests defined in the repository using TurboRepo.
### Contributing
Contributions are welcome! Please fork this repository, make your changes, and submit a pull request.
### License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.