https://github.com/mudssrali/url-shortener

A dead simple URL shortener implementation in Elixir
https://github.com/mudssrali/url-shortener

elixir elixir-lang url-shortener url-shortener-microservice

Last synced: 3 days ago
JSON representation

A dead simple URL shortener implementation in Elixir

• Host: GitHub
• URL: https://github.com/mudssrali/url-shortener
• Owner: mudssrali
• Created: 2023-09-03T20:42:41.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-04T11:53:31.000Z (about 1 year ago)
• Last Synced: 2023-09-04T20:21:15.361Z (about 1 year ago)
• Topics: elixir, elixir-lang, url-shortener, url-shortener-microservice
• Language: Elixir
• Homepage:
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# URL Shortener

A dead simple URL shortener implementation in Elixir

## Tasks

- [x] Create short url module

- [x] Write a server to manage `shorten/1`, `get/1`, `flush/0`, and `count/0` requests

- [x] Unit Testing

## Environment Setup

  * Install elixir `1.14.3`

To start application

  * Install dependencies with `mix deps.get`

  * Start inside IEx with `iex -S mix`

## Mix Test

Run following commands to run `tests` using `mix test` utility

> mix test

## Roadmap

- [ ] User account

- [ ] Implement url expiration

- [ ] Write clean up service

- [ ] Preserve data on database e.g. `mnesia` or `postgres`

- [ ] Create an API server

- [ ] Implement Rate Limiter

- [ ] Implement URL validation

- [ ] Unit Testing

- [ ] Dockerize