deolivtiago/bourdox-api

Bourdox Platform API

Bourdox Platform API

Setup

Getting started

• Rename the .env.example file to .env and set the environment variables values

Choose your preferred environment and follow the instructions:

• Local
• asdf

Local

Requirements:

• Install Elixir 1.16.0
• Install Erlang 26.2.1

To start your Phoenix server:

• Install dependencies with mix deps.get
• Setup database with mix setup
• Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

asdf

Requirements:

• Install asdf
• Install Elixir and Erlang with asdf install

To start your Phoenix server:

• Install dependencies with mix deps.get
• Setup database with mix setup
• Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

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

Learn more

• Official website: https://www.phoenixframework.org/
• Guides: https://hexdocs.pm/phoenix/overview.html
• Docs: https://hexdocs.pm/phoenix
• Forum: https://elixirforum.com/c/phoenix-forum
• Source: https://github.com/phoenixframework/phoenix