jpyamamoto/shorty

A URL shortener

Shorty

URL shortener

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

A simple URL shortener made in Elixir, with the Phoenix Framework.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally.

To get a local copy up and running follow these simple example steps.

Prerequisites

• Elixir installation

Installation

To start your Phoenix server:

1. Run mix setup to install and setup dependencies
2. Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server
3. Now you can visit localhost:4000 from your browser.

The server runs with a SQLite database, so no steps to setup the database are necessary.

(back to top)

Usage

Browser

This project can be used through the browser, with the input that will shorten a URL.

API

To shorten a new link:

# POST /api/new

{"url": "http://example.com"}

To retrieve the information about a shortened URL:

# GET /api/:key

(back to top)

Roadmap

• Cache with ETS tables
• Browser and API
• Analytics
  • Number of visits

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Juan Pablo Yamamoto - @jpyamamoto - jpyamamoto@ciencias.unam.mx

Project Link: https://github.com/jpyamamoto/shorty

(back to top)