Skip to content

Latest commit

 

History

History
30 lines (28 loc) · 1.3 KB

DEVELOPMENT.md

File metadata and controls

30 lines (28 loc) · 1.3 KB

Steps

  1. Install asdf: https://asdf-vm.com/#/core-manage-asdf-vm
  2. Install Erlang, Elixir and NodeJS plugins for asdf:
  1. Use asdf to install the versions we are using: asdf install (from repository root dir)
  • May need to asdf reshim if previous versions were in installed
  1. Setup environment variables
  • Create a .env with all the environment variables we are using (TODO: this needs more instructions)
  • OR, install dotenv from ruby to load the .env file
  1. Install a postgres server
  2. Install dependencies
  • Without dotenv mix deps.get
  • Via dotenv dotenv mix deps.get
  1. Setup tables and data
  • Without dotenv:
    • cd apps/institute; mix ecto.reset
  • Via dotenv:
    • cd apps/institute; dotenv mix ecto.create
    • cd apps/institute; dotenv mix ecto.migrate
  1. Install NPM packages
  • cd apps/institute_web/assets; npm install
  1. Start Phoenix
  • Without dotenv: cd path/to/project/root; mix phx.server
  • Via dotenv: cd path/to/project/root; dotenv mix phx.server
  1. Visit http://localhost:4002 and enjoy the site!

Also note that all submitted PR's should follow the code of conduct: https://institute.gigalixirapp.com/code_of_conduct