davidbrusius / shortener

URL Shortener with Elixir

Shortz ⚡

Shortz is a URL shortener application built with Elixir!

The app is currently deployed at https://shortz.fly.dev/ using Fly.io.

GitHub Pull Requests contain valuable information about decisions made during the coding process. Please refer to them for more details.

Requirements

• docker

Setup

This setup covers installation using docker. Make sure you have it up and running before continuing.

To run the app locally, follow the instructions bellow. Before you start, please make sure:

1. You have Docker up and running.
2. No other processes or services are using the 4000 and 5432 ports in your machine.

Clone the repository into your local machine:

git clone [email protected]:davidbrusius/shortener.git

Switch to the project directory:

cd shortener

Build docker images:

docker compose build

Install deps:

docker compose run --rm shortener mix do deps.get, deps.compile

Setup Shortener database:

docker compose run --rm shortener mix ecto.setup

All done! You can now run the Shortener app!

Running

Run the Shortener app:

docker compose up

The app will be available at http://localhost:4000

Run tests:

docker compose run --rm shortener mix test