gen_template_ecto_server v0.1.0 Mix.Gen.Template.Project
Ecto Server
This simple table creates an application that can use a database and Ecto. It is intended to be used to create resource-servers in an application where each resource runs in its own application.
You use it in combination with the mix gen
mix task, which you will need
to install.
New Project Template
mix gen ecto_server «name» [ --into «path» ]
Install
This template is installed using the template.install
mix task.
Projects are generated from it using the mix gen
task.
So, before using templates for the first time, you need to install these two tasks:
$ mix archive.install mix_templates
$ mix archive.install mix_generator
Then you can install this template using
$ mix template.install gen_template_ecto_server
Use
To create a basic project, with no supervision and no application, run:
$ mix gen project «project_name»
«project_name»
is both the name of the subdirectory that will hold the
project and the name that will be given to the application. This
affects entries in mix.exs
as well as the names of the main
file in lib/
and the skeleton test in test/
. The application
module name will be the camelcase version of «name».
By default the subdirectory will be created under your
current directory; you can change this with the --into
option:
$ mix gen project «project_name» --into some/other/dir
Then…
Update
config/{dev,test,prod}.exs
with your database credentials.mix deps.get
mix ecto.gen.migration
is neededUpdate the schema in lib/«project»/table.ex
Write your API in lib/«project».ex
Link to this section Summary
Functions
Return the name or path of a template that this template is based upon. That template will be processed first, and then this one will be executed
Override this function to do any cleanup after your template has been copied into the user project. One use of this is to remove unwanted files created by a template upon which this template is based
Return the name of this template as an atom. This is the name passed to the gen command
Return the list of options supported by this template
Return the short description of this template, or nil
Return the absolute path to the tree that is to be copied when
instantiating this template. This top-level dir will typically
just contain a directory called $APP_NAME$
Link to this section Functions
Return the name or path of a template that this template is based upon. That template will be processed first, and then this one will be executed.
Override this function to do any cleanup after your template has been copied into the user project. One use of this is to remove unwanted files created by a template upon which this template is based.
Return the name of this template as an atom. This is the name passed to the gen command.
Return the list of options supported by this template.
Return the short description of this template, or nil.
Return the absolute path to the tree that is to be copied when
instantiating this template. This top-level dir will typically
just contain a directory called $APP_NAME$
.