You will need:
- erlang
- elixir
- node
- postgres
Or:
- docker
We do use a bunch of integrations, so if you want to replicate the whole project you will need:
- Amazon AWS: set
AWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
- Mailgun: set
MAILGUN_API_KEY
- Timepad: set
TIMEPAD_KEY
- ReCaptcha: set
RECAPTCHA_PRIVATE_KEY
andRECAPTCHA_PUBLIC_KEY
To run app in docker
container:
- Clone the repo
- Run
docker-compose build
- Run
docker-compose run web mix test
to test the installation - Run
docker-compose run web mix ecto.setup && mix ecto.migrate
- Run
dcoker-compose up
Now you can visit localhost:4000
from your browser.
To clean up:
docker rm -v $(docker ps -a -q -f status=exited)
docker rmi $(docker images -f "dangling=true" -q)
Add these lines to /ets/hosts
:
# docker
127.0.0.1 docker.local
127.0.0.1 db
And now, run:
- Clone the repo
- Run
mix deps.get && mix compile
- Run
mix test
to ensure that everything is fine - Run
mix ecto.setup && mix ecto.migrate
to setup the database - Install Node.js dependencies with
yarn install
(you may need to installyarn
) - Start Phoenix endpoint with
mix phoenix.server
. Now you can visitlocalhost:4000
from your browser.
Run:
mix command.create.admin username:$YOUR_NAME password:$YOUR_PASS password_confirmation:$YOUR_PASS
We use hackcss
as a css-framework. We use yarn
as a default package manager for frontend. And brunch
as an assets-builder.
This project uses several linters to lint 'all the things!!!':
credo
to lintelixir
codeeslint
to lintjavascript
codesass-lint
to lintscss
styles
- Official website: http://www.phoenixframework.org/
- Guides: http://phoenixframework.org/docs/overview
- Docs: http://hexdocs.pm/phoenix
- Mailing list: http://groups.google.com/group/phoenix-talk
- Source: https://github.com/phoenixframework/phoenix