bump_server/README.md

32 lines
912 B
Markdown
Raw Permalink Normal View History

2021-12-05 00:42:08 +01:00
# Bump Server
2021-12-05 00:35:32 +01:00
2021-12-05 00:42:08 +01:00
Bump Server is an elixir based rest server that is used to communicate messages between clients
# Setup
To start your Phoenix server:
* Install dependencies with `mix deps.get`
* Create and migrate your database with `mix ecto.setup`
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
## 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
## TODOs
[x] finish api calls in lib/bump/messages.ex
[x] add rest api and connect to database api