https://github.com/wpcfan/devcontainer-nestjs-postgresql

https://github.com/wpcfan/devcontainer-nestjs-postgresql

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wpcfan/devcontainer-nestjs-postgresql
• Owner: wpcfan
• Created: 2024-06-21T08:43:35.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-06-22T01:29:03.000Z (6 months ago)
• Last Synced: 2024-06-23T14:34:54.158Z (6 months ago)
• Language: Dockerfile
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 适合于 Nestjs 开发的 devcontainer 配置

这是一个适合于 Nestjs 开发的 devcontainer 配置，可以在 vscode 中使用 devcontainer 插件直接启动一个开发环境。 已经包含 `nodejs`、`typescript`、`nest`、`PostgreSQL`、`adminer` 等常用工具和服务。

## 使用方法

1. 安装 vscode 插件：Remote - Containers

2. 使用 Github 的模板功能，创建一个新的仓库，即在本仓库的右上角点击 `Use this template`，然后在新仓库中 clone 代码。

3. 打开 vscode，打开项目根目录

4. 点击左下角的 `><` 图标，选择 `Reopen in Container`

## 配置说明

- `Dockerfile`：用于构建 devcontainer 的 Dockerfile

- `devcontainer.json`：devcontainer 配置文件

- `docker-compose.yml`：用于启动数据库等服务

## 服务说明

- `nodejs`：nodejs 环境

- `typescript`：typescript 编译环境

- `nest`：nest 框架

- `PostgreSQL`：数据库

- `adminer`：数据库管理工具

## 运行端口

- `3000`：nest 服务

- `8081`：adminer

- `5432`：PostgreSQL

## 注意事项

- 请确保安装了 Docker Desktop

- 请确保安装了 vscode 插件：Remote - Containers

- 请避免端口冲突，如有冲突请修改 `docker-compose.yml` 中的端口映射，本项目默认暴露端口为 `3000`、`8081`、`5432`