README.md
# phx_custom
> Opinioned code patcher for projects generated by `mix phx.new`.
## Dependencies
- Node.js >= 9.11.2
- Phoenix >= 1.5.0
> Extractor of PurgeCSS is using a regular expression which is only compatible with Node.js >= 9.11.2.
## Installation
Install latest version:
```sh
mix archive.install github c4710n/phx_custom
```
Install released version on [Hex.pm](https://hex.pm/):
```
mix archive.install hex phx_custom
```
## Available Tasks
- `mix phx.custom.web`
- `mix phx.custom.release`
- `mix phx.custom.docker`
## Usage
Visit [HexDocs](https://hexdocs.pm/phx_custom) for more details.
For now, have a look at the following quickstart:
```sh
# create an project
$ mix phx.new project
$ cd project
# patch web related code
$ mix phx.custom.web .
# install dependencies
$ mix deps.get
# patch project for using `mix release`
$ mix phx.custom.release .
$ mix ecto.setup
$ mix phx.server
# patch project for using Docker
$ mix phx.custom.docker .
# build an image for production
$ docker build -t project .
```
## License
MIT