Create a Project

Creates a new Clean architecture scaffold

    $ mix ca.new.structure [application_name]
    $ mix ca.new.structure [application_name] --metrics --sonar --monorepo
    $ mix ca.new.structure [application_name] -m -s -r

Creating a new project

The ca.new.structure task will generate a clean architecture structure in your project.

Options

--metrics or -m: this option will create a basic setup for metrics, this can be done after project creation too, by executing mix ca.apply.config -t metrics
--sonar or -s: this option will create a basic setup for sonar reports, this can be done after project creation too, by executing mix ca.apply.config -t sonar
--monorepo or -r: this option will create a basic set some paths relative to project name.

mix ca.new.structure <project-name>

mix ca.new.structure <project-name> --metrics

mix ca.new.structure <project-name> -m

For example:

mix ca.new.structure app -m -s

The structure will look like this

app
├── config
│   ├── config.exs
│   ├── dev.exs
│   ├── prod.exs
│   └── test.exs
├── coveralls.json
├── lib
│   ├── application.ex
│   ├── config
│   │   ├── app_config.ex
│   │   └── config_holder.ex
│   ├── domain
│   │   ├── behaviours
│   │   ├── model
│   │   └── use_cases
│   ├── infrastructure
│   │   ├── driven_adapters
│   │   └── entry_points
│   │       ├── api_rest.ex
│   │       └── health_check.ex
│   └── utils
│       ├── custom_telemetry.ex # if --metrics enabled
│       └── data_type_utils.ex
├── mix.exs
├── mix.lock
├── resources
│   └── cloud
│       ├── Dockerfile
│       └── Dockerfile-build
└── test
    ├── infrastructure
    │   └── entry_points
    │       └── api_rest_test.exs
    ├── app_application_test.exs
    ├── support
    │   └── test_stubs.exs
    └── test_helper.ex

Generated base applications comes with a REST Entry Point which listens on port 8083

After project generation you ca enter and run it

cd app
iex -S mix

Enter to http://localohst:8083/api/health and your api will reply with:

[
  {
    "error": null,
    "healthy": true,
    "name": "http",
    "time": 1
  }
]

Testing and Code Analysis at local

Basically you can run mix ca.release --skiprelease all outputs will be generated at _build/release folder

Or you can run it with the file app_name/resources/cloud/Dockerfile-build and the next script

At local you can use the next script to build and analize your project inside docker using deps caching

sh_build.sh

set -e
BASE_IMAGE=$1
# Change it
APP_NAME=name_project
mkdir -p _build
rm -rf _build/release
docker build --build-arg IMAGE=$BASE_IMAGE -t $APP_NAME -f resources/cloud/Dockerfile-build .
docker stop $APP_NAME || true
docker rm $APP_NAME || true
docker run -d --name $APP_NAME $APP_NAME
docker cp $APP_NAME:/app/_build/release _build/release
docker stop $APP_NAME || true
docker rm $APP_NAME || true
docker rmi $APP_NAME --force
cp -r deployment _build/release/artifact
ls -lR _build/release

./sh_build.sh elixir:alpine

Create a Project

Creating a new project​

Options​

Testing and Code Analysis at local

Creating a new project

Options