dx: add Makefile to simplify getting started

Author: zcesur

.env.example

@@ -6,7 +6,7 @@ LOGIN_CODE_SALT="algora-login-code"
 LOCAL_STORE_TTL=3600
 LOCAL_STORE_SALT="algora-local-store"
 
-DATABASE_URL="postgresql://algora:password@localhost:5432/algora"
+DATABASE_URL="postgresql://postgres:postgres@localhost:15432/algora_dev"
 
 GITHUB_CLIENT_ID=""
 GITHUB_CLIENT_SECRET=""

Makefile

@@ -0,0 +1,24 @@
+.PHONY: help install uninstall server watch postgres psql postgres-rm
+
+help:
+	@perl -nle'print $& if m{^[a-zA-Z_-]+:.*?## .*$$}' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+install: ## Run the initial setup
+	mix setup
+
+uninstall: postgres-rm ## Remove all containers
+
+server: ## Start the web server
+	iex -S mix phx.server
+
+watch: ## Recompile on file changes
+	find lib/ | entr mix compile
+
+postgres: ## Start a container with latest postgres
+	docker run --detach -e POSTGRES_PASSWORD="postgres" -p 15432:5432 --name algora_db --volume=algora_db:/var/lib/postgresql/data postgres:latest
+
+postgres-rm: ## Stop and remove the postgres container
+	docker stop algora_db && docker rm algora_db
+
+psql: ## Connect to postgres
+	docker exec -it algora_db psql -U postgres -d algora_dev

README.md

@@ -112,16 +112,18 @@ To get a local copy up and running, follow these steps.
 
 ### Prerequisites
 
-- PostgreSQL
-- [asdf](https://github.com/asdf-vm/asdf) (optional) - install Elixir and Erlang/OTP
-- [direnv](https://github.com/direnv/direnv) (optional) - load environment variables
+The easiest way to get up and running is to [install](https://docs.docker.com/get-docker/) and use Docker for running Postgres.
+
+Make sure Docker, Elixir, Erlang and Node.js are all installed on your development machine. The [.tool-versions](https://github.com/algora-io/algora/blob/main/.tool-versions) file is available to use with [asdf](https://github.com/asdf-vm/asdf) or similar tools.
+
+We also recommend using [direnv](https://github.com/direnv/direnv) to load environment variables and [entr](https://github.com/eradman/entr) to watch for file changes.
 
 ### Setting up the project
 
 1. Clone the repo and go to the project folder
 
    ```sh
-   git clone https://github.com/algora-io/algora.git; cd algora
+   git clone git@github.com:algora-io/algora.git && cd algora
    ```
 
 2. Install Elixir and Erlang/OTP
@@ -130,40 +132,28 @@ To get a local copy up and running, follow these steps.
    asdf install
    ```
 
-3. Create a new PostgreSQL user
-
-   ```sh
-   sudo -u postgres psql
-   ```
-
-   ```sql
-   CREATE USER algora WITH PASSWORD 'password';
-   ALTER USER algora WITH CREATEDB;
-   ```
-
-4. Initialize and load `.env`
+3. Initialize and load `.env`
 
    ```sh
-   cp .env.example .env
-   direnv allow .env
+   cp .env.example .env && direnv allow .env
    ```
 
-5. Install and setup dependencies
+4. Install and setup dependencies
 
    ```sh
-   mix setup
+   make install
    ```
 
-6. Start your development server
+5. Start the web server inside IEx
 
    ```sh
-   iex -S mix phx.server
+   make server
    ```
 
-7. (Optional) Watch for file changes and auto reload IEx shell in a separate terminal
+6. (Optional) Watch for file changes and auto reload IEx shell in a separate terminal
 
    ```sh
-   find lib/ | entr mix compile
+   make watch
    ```
 
 ### Setting up external services