README.md
# phx_custom
> Custom official template generated by `mix phx.new` with my own needs.
## Features
phx_custom provides following Mix tasks:
- `mix phx.custom.web`
- `mix phx.custom.config`
- `mix phx.custom.docker`
- `mix phx.custom.yarn`
## Installation
Install latest version:
```sh
mix archive.install github m31271n/phx_custom
```
Install released version on [Hex.pm](https://hex.pm/):
```
mix archive.install hex phx_custom
```
## Usage
> For now, phx_custom only support projects generated by `phx_new >= 1.4.10`.
A general process for initializing a new project:
```sh
# create an umbrella project
$ mix phx.new --umbrella project
$ cd project
# patch custom web template
$ mix phx.custom.web .
# install dependencies
$ mix deps.get
$ mix phx.custom.yarn .
# patch config with optimization for production
$ mix phx.custom.config .
# run
$ mix ecto.create
$ mix phx.server
# patch Dockerfile
$ mix phx.custom.docker .
# build an image for production
$ docker build -t project .
```
## License
[MIT](https://stack.m31271n.com/licenses/MIT.txt) © [m31271n](https://stack.m31271n.com)