Skip to content

Commit

Permalink
chat-service: improve readme
Browse files Browse the repository at this point in the history
Signed-off-by: Victor Login <batazor@evrone.com>
  • Loading branch information
batazor committed Dec 25, 2023
1 parent 9cdb22a commit b1c6d80
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 15 deletions.
16 changes: 16 additions & 0 deletions internal/boundaries/chat/chat/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
SELF_DIR := $(dir $(lastword $(MAKEFILE_LIST)))

# INCLUDE ==============================================================================================================
# Include Makefile
include ../../../../ops/Makefile/common.mk

deps: ## Install dependencies
@mix local.hex
@mix deps.get

migration: ## Create and migrate your database
@mix ecto.setup

start: ## Start the application
@echo "Open http://localhost:4000"
@mix phx.server
28 changes: 13 additions & 15 deletions internal/boundaries/chat/chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,26 @@

Chat platform

### Getting start
### Getting started

To start your Phoenix server:
We use Makefile for build and deploy.

* Install dependencies with `mix local.hex` and `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).
```bash
$> make help # show help message with all commands and targets
```

### Requirements

- Elixir
- Phoenix
- Postgres
- Cassandra

### 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
> [!TIP]
>
> * 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

0 comments on commit b1c6d80

Please sign in to comment.