Skip to content

Instantly share code, notes, and snippets.

@zacck-zz

zacck-zz/setup_guide.md

Created March 21, 2019 08:04
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save zacck-zz/09f80f0d65cdf3ca34e59333a0db3c90 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save zacck-zz/09f80f0d65cdf3ca34e59333a0db3c90 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
setup_guide.md

Getting Up and Running

Getting Up and Running

This guide assumes you Elixir and Erlang set up on your machine If not follow the installation instructions for your system.

  1. Clone the development branch using git clone repo
  2. Follow this guide to setup postgres on your system if you haven't already
  3. From the downloaded qb_backend folder run the following
  4. Run mix deps.get to install dependecies
  5. Run mix ecto.create to create the application database
  6. Run mix ecto.migrate to run the migrations on the created database
  7. Run npm install in the assets directory to install javascript assets
  8. Run MIX_ENV=test mix test this should exit with a status of 0
  9. If you intend on contributing code, set up your local githooks by copying the files in the /hooks folder into the .git folder cd hooks && cp * ../.git/hooks && cd ..
  10. Make the precommit hook executable using chmod +x .git/hooks/pre-commit
  11. Make the precommit hook executable using chmod +x .git/hooks/pre-push
  12. Run mix phx.server and the application should be available at localhost:4000

Ready to hack away!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment