This is the Elixir and Phoenix backend API for the Shikoba Platform

Installation

Requirements

You will need to install the following:

• Elixir
• PostgreSQL

Clone this repository

You'll want to clone this repository with git clone git@github.com:vejovove/shikoba-api.git. If you plan on contributing, you'll want to fork it too!

To start your Phoenix server:

• Install dependencies with cd backend/ && mix deps.get and cd frontend/ && yarn install
• Configure database credentials: cp backend/config/dev.secret.example.exs backend/config/dev.secret.exs
• Create and migrate your database with cd backend/ && mix ecto.setup
• Start Phoenix endpoint with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

Contributing

All contributions are more than welcome! PRs without tests won't be accepted.

Please, follow the guidelines