README.md

NekoCaffe

Development environment

• Install elixir/erlang using asdf

Information to install asdf can be found here

asdf plugin-add erlang https://github.com/asdf-vm/asdf-erlang
asdf plugin-add elixir https://github.com/asdf-vm/asdf-elixir

asdf install

or install Erlang and Elixir on your machine.

Development environment variables

In the .env file environments vars needs to be defined for the local environments. Those need to be loaded when working with this project. To do so, one can manually execute:

source .env

or automate this process using direnv.

# Install direnv using brew
$ brew install direnv

# From the project folder
$ direnv allow

Continue with the instructions here

Development environment database

• Install docker&docker-compose

Information to install docker can be found here Information to install docker-compose can be found here

Set up postgresql database:

$ docker network create neko_caffe_network
$ docker-compose up

Phoenix framework

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

• 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