shibao/cannery
shibao/cannery
1
2
Fork 1
Code Issues 16 Pull Requests Projects 1 Releases 36 Wiki Activity
The self-hosted firearm tracker app
17 Commits 3 Branches 37 Tags 13 MiB
Elixir 79.3%
HTML 18.3%
JavaScript 1.4%
SCSS 0.8%
Dockerfile 0.2%
50a8a79596
Go to file
shibao 50a8a79596 update readme and docker-compose.yml
2022-01-22 23:44:47 -05:00
assets format with standard js 2022-01-22 22:56:53 -05:00
config set generator settings 2022-01-22 20:13:53 -05:00
lib fix tests 2022-01-22 20:44:38 -05:00
priv update to 1.6 2022-01-22 14:25:37 -05:00
test fix tests 2022-01-22 20:44:38 -05:00
.formatter.exs add heex_formatter 2022-01-22 15:24:04 -05:00
.gitignore update to 1.6 2022-01-22 14:25:37 -05:00
.tool-versions add heex_formatter 2022-01-22 15:24:04 -05:00
docker-compose.yml update readme and docker-compose.yml 2022-01-22 23:44:47 -05:00
Dockerfile add touchless docker deploys 2021-09-04 16:19:23 -04:00
mix.exs add standard js 2022-01-22 22:56:38 -05:00
mix.lock add heex_formatter 2022-01-22 15:24:04 -05:00
readme.md update readme and docker-compose.yml 2022-01-22 23:44:47 -05:00

readme.md

Lokal

Lokal is a local business aggregation site helping you to shop locally by providing a one-stop-shop for your local community. Set your profile and start shopping today!

Features

  • User Registration/Sign in via phx_gen_auth
  • Dockerfile and example docker-compose.yml
  • Automatic migrations in MIX_ENV=prod or Docker image
  • JS linting with standard.js, HEEx linting with heex_formatter

Installation

  1. Clone the repo
  2. Run mix setup
  3. Run mix phx.server to start the development server

Configuration

For development, I recommend setting environment variables with direnv.

MIX_ENV=dev

In dev mode, Lokal will listen for these environment variables on compile.

  • HOST: External url to generate links with. Set these especially if you're behind a reverse proxy. Defaults to localhost.
  • PORT: External port for urls. Defaults to 443.
  • DATABASE_URL: Controls the database url to connect to. Defaults to ecto://postgres:postgres@localhost/lokal_dev.

MIX_ENV=prod

In prod mode (or in the Docker container), Lokal will listen for these environment variables at runtime.

  • HOST: External url to generate links with. Set these especially if you're behind a reverse proxy. Defaults to localhost.
  • PORT: Internal port to bind to. Defaults to 4000 and attempts to bind to 0.0.0.0. Must be reverse proxied!
  • DATABASE_URL: Controls the database url to connect to. Defaults to ecto://postgres:postgres@lokal-db/lokal.
  • ECTO_IPV6: Controls if Ecto should use ipv6 to connect to PostgreSQL. Defaults to false.
  • POOL_SIZE: Controls the pool size to use with PostgreSQL. Defaults to 10.
  • SECRET_KEY_BASE: Secret key base used to sign cookies. Must be generated with mix phx.gen.secret and set for server to start.