https://github.com/EssenceOfChaos/lil_links

Blazing fast URL shortening API. Created with Elixir.
https://github.com/EssenceOfChaos/lil_links

elixir elixir-lang phoenix-framework url-shortener

Last synced: about 1 month ago
JSON representation

Blazing fast URL shortening API. Created with Elixir.

• Host: GitHub
• URL: https://github.com/EssenceOfChaos/lil_links
• Owner: EssenceOfChaos
• License: mit
• Created: 2019-04-06T04:33:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-03T04:50:28.000Z (about 5 years ago)
• Last Synced: 2024-08-02T05:12:09.964Z (4 months ago)
• Topics: elixir, elixir-lang, phoenix-framework, url-shortener
• Language: Elixir
• Size: 185 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-blazingly-fast - lil_links - Blazing fast URL shortening API. Created with Elixir. (Elixir)

README

        
# LilLinks

LilLinks is a blazing fast URL shortening service. It's written in Elixir with availability, scalability, and performance in mind. Progress is still ongoing with plans to add additional features to shortened links such as:

- expiration dates

- password protection

- high volume resiliency

To start the application, `git clone` to get a local copy. `cd lil_links` and run `mix.deps.get` to fetch the application dependencies. Next, start the application with `mix phx.server`. _(Note: an active instance of postgres will have to be running locally on the default port of `5432`.)_

Feel free to request a feature or submit a pull request.

Example POST request:

![Insomnia screenshot](https://github.com/EssenceOfChaos/lil_links/blob/master/assets/screenshots/example-post-req.png 'Example POST request')

Example GET request:

In the browser navigate to `http://localhost:4000/api/:hash`, where `:hash` is replaced with the hash received in the reponse of a POST request.

For example: while the application is running, navigating to `http://localhost:4000/api/6R2k1F` redirects to `https://elixircasts.io/json-api-with-phoenix-1.4`