diff --git a/README.md b/README.md index 7adf8ab..bb59692 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # DecentralisedBookIndex -To start your Phoenix server: +**DecentralisedBookIndex** is a web-server to manage the book metadata in the decentralise manner. - * Run `mix setup` to install and setup dependencies - * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server` +## Getting started +- clone this repository +- copy `.env.example` file and save as `.env` +- copy `.env_db.example` file and save as `.env_db` +- change the values in `.env` and `.env_db` + you can use `mix phx.gen.secret` to generate secrets + update the PHX_HOST to your domain name +- run `docker compose up -d` +- run migrations `docker exec -it dbi bin/migrate` -Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. +# Author -Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html). +Kostiantyn Klochko (c) 2023-2025 -## 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