Udia

Universal Dream | Infinite Awareness

The public facing API can be found at https://a.udia.ca/.
The public client is at udia-software/udia-client and can be found at https://www.udia.ca

Quickstart (Development)

This project is using the Phoenix Framework 1.3 Release Client (upgrade instructions).

Setup (Docker)

Ensure Docker is installed on your machine.

Clone this repository and change directories into it git clone https://github.com/udia-software/udia.git; cd udia
Run docker-compose build.
Run database migrations with docker-compose run app mix ecto.migrate.
Start the web application with docker-compose up.

Setup (without Docker on OSX/Linux)

Elixir & Hex:

Update your homebrew to latest: brew update
Install Elixir: brew install elixir
Install Elixir's package manager Hex: mix local.hex
Alternatively install Elixir using your distribution's package manager.

Phoenix:

Install the latest Phoenix Mix Archive: mix archive.install https://github.com/phoenixframework/archives/raw/master/phx_new.ez

PostgreSQL:

Download and run the Postgres.app https://postgresapp.com
Alternatively setup your PostGreSQL instance and configure all relevant environment variables

To start the application:

Clone this repository and change directories into it git clone https://github.com/udia-software/udia.git; cd udia
Install dependencies with mix deps.get
Create and migrate your database with mix ecto.create && mix ecto.migrate
Start Phoenix endpoint with mix phx.server or iex -S mix phx.server
(Optional) Seed your database with mix run priv/repo/seeds.exs

Now you can visit localhost:4000 from your browser.

Testing

To test your phoenix app:

Set your mix environment variable to test export MIX_ENV=test
Install dependencies with mix deps.get
Create and migrate your database with mix ecto.create && mix ecto.migrate
Run your tests with mix test
Generate a test coverage report with mix coveralls
Generate a code analysis report with mix credo

Deployment

Ready to run in production? Please check our deployment guides.

Udia is currently configured to run on Heroku using:

heroku-buildpack-elixir

Within the Procfile, a heroku release will run POOL_SIZE=2 mix ecto.migrate every time a successfull deploy to master finishes. This will ensure seemless database migrations when deploying code to production.

Development/Testing Configuration & Environment Variables

Application will work with default settings if using something like PostgresApp, however if you need to change the credentials the following enviornment variables are available.

Environment Variable	Default Value	Description
`POSTGRES_USERNAME`	`"postgres"`	PostgreSQL DB Username
`POSTGRES_PASSWORD`	`"postgres"`	PostgreSQL DB Password
`POSTGRES_DEV_DB`	`"udia_dev"`	Development DB Name
`POSTGRES_TEST_DB`	`"udia_test"`	Test DB Name
`POSTGRES_HOSTNAME`	`"localhost"`	Hostname for DB
`POSTGRES_PORT`	`5432`	Port for DB

Production Environment Variables

The following environment variables must be set for the application to run in production.

Environment Variable	Default Value	Description
`PORT`	``	Port for web endpoint
`DOMAIN_NAME`	`"udia.herokuapp.com"`	Domain name for web
`SECRET_KEY_BASE`	``	Secret key for web
`DATABASE_URL`	``	Postgres database URL
`POOL_SIZE`	`"10"`	Postgres pool size
`GUARDIAN_SECRET_KEY`	``	Secret for Guardian
`CLIENT_ORIGIN_URL`	`"https://www.udia.ca"`	Domain URL for client

License

Udia Software Incorporated (UDIA)

Common Public Attribution License Version 1.0 (CPAL)

Full license text can be found at LICENSE