nicbet/phoenix

Docker化Elixir/Phoenix开发环境

!GitHub tag (latest SemVer) !Docker Cloud Build Status

概述

该项目旨在提供Docker化的Elixir/Phoenix开发环境，解决不同Elixir和Phoenix版本项目的开发环境一致性问题。随着Elixir和Phoenix的不断更新，多版本项目开发时易出现环境冲突，此镜像通过容器化方案，统一开发环境配置，简化多版本项目的开发流程。

核心功能和特性

• 多版本支持：通过仓库标签指定不同Phoenix版本，适配多版本项目开发
• VS Code集成：支持VS Code Remote Extension，克隆仓库后打开即可自动启动包含PostgreSQL的完整开发环境
• 数据库集成：内置PostgreSQL数据库服务，通过db主机名访问
• 便捷命令：提供./mix和./run脚本，简化容器内命令执行
• 发布支持：支持基于Alpine Linux构建最小化Docker发布镜像（约38MB）

使用场景和适用范围

• 需要在同一台机器上开发多个不同Elixir/Phoenix版本项目的开发者
• 希望快速搭建标准化Phoenix开发环境的团队
• 需要通过VS Code Remote Extension进行远程开发的场景
• 需简化Phoenix应用发布流程的项目

使用方法和配置说明

快速开始

1. 克隆仓库，可通过标签指定特定Phoenix版本：

   bash
   # 示例：克隆Phoenix 1.5.9版本的开发环境
   git clone -b 1.5.9 https://github.com/nicbet/docker-phoenix ~/Projects/hello-phoenix
   

VS Code Remote Extension支持

克隆仓库后，使用VS Code Remote Extension打开文件夹，将自动启动包含PostgreSQL数据库的完整开发环境。详情参见VS Code Remote Containers文档。

Elixir 1.9+发布支持

遵循https://gist.github.com/nicbet/102f16359828405ce34ca083976986e1%E6%8C%87%E5%8D%97%EF%BC%8C%E5%8F%AF%E5%9F%BA%E4%BA%8EAlpine Linux构建最小化Docker发布镜像（Phoenix Web应用约38MB）。

从零创建新应用

1. 进入克隆目录：

   bash
   cd ~/Projects/hello-phoenix
   

2. 初始化新Phoenix应用（将在src/目录下创建名为hello的应用）：

   bash
   ./mix phx.new . --app hello
   

   注意事项：

   • 必须通过--app <name>指定应用名称，否则Phoenix会使用目标目录名（此处为.）作为应用名
   • 当提示/app目录已存在时，回答Y即可
   • Phoenix 1.3.0+版本需使用phx.new命令，替代已废弃的phoenix.new

导入现有应用

1. 创建src/目录（仓库默认不含此目录）：

   bash
   mkdir src
   

2. 将现有Phoenix应用代码复制到src/目录

数据库配置

配置准备

docker-compose.yml定义了名为db的PostgreSQL服务，可通过db主机名访问。需修改Ecto配置文件src/config/dev.exs指向数据库容器：

elixir
# 配置数据库连接
config :test, Test.Repo,
  adapter: Ecto.Adapters.Postgres,
  username: "postgres",
  password: "postgres",
  database: "test_dev",
  hostname: "db",  # 指向db容器
  pool_size: 10

初始化数据库

1. 创建开发数据库：

   bash
   ./mix ecto.create
   

2. 执行数据库迁移（适用于现有应用）：

   bash
   ./mix ecto.migrate
   

启动应用

使用以下命令启动应用：

bash
docker-compose up

应用启动后可通过 http://localhost:4000 访问。

其他说明

执行自定义命令

使用./run脚本执行容器内非mix命令，例如：

bash
./run iex -S mix