Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 1.94 KB

README.md

File metadata and controls

62 lines (37 loc) · 1.94 KB
Raw

Plank

A board. Like Trello, but worse. Use at your own peril.

Licence

Plank is licenced under AGPLv3

Environment

Secrets

Run cp ./docker/app/.env.dist ./docker/app/.env && cp ./docker/postgres/.env.dist ./docker/postgres/.env

And populate them with valid secrets. Make sure that postgres secrets match DB_ section in the app's .env

Use mix to generate secret values for ./docker/app/.env

SECRET_KEY_BASE - docker-compose exec app bash -c "cd /app && mix phx.gen.secret"

LIVE_VIEW_SALT - docker-compose exec app bash -c "cd /app && mix phx.gen.secret 32"

Run

Whilst it can be run locally. Development is easier when using Docker.

Use ./bin/start.sh to start the environment. Use ./bin/restart-app.sh to restart the app container.

Assuming you have not modified the HOST_DOMAIN in app/.env please add 127.0.0.1 plank.local to your hosts file (usually, /etc/hosts)

In your browser navigate to plank.local:4000
Irrespective of the above you can always use localhost:4000

Notes

First run requires deps and ecto commands to run. To do that use: ./bin/update-app.sh

Standard Phoenix setup

To start your Phoenix server:

  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.setup
  • Install Node.js dependencies with npm install inside the assets directory
  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

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

Learn more