byhbt / linkir

Shorten Links using Elixir and Phoenix framework

Linkir

• Sample README structure
• License (https://choosealicense.com)
• Issue template (Bug/Feature Request/Refactor/Small Updates)
• Pull Request template
• Wiki docs
• Github Action setup

Getting Started

Features

• Create Short Link

Prerequisites

• React 16.8.0
• npm

Installation

To start your Phoenix server:

• Install dependencies with mix deps.get
• Create and migrate your database with mix ecto.setup
• Install Node.js dependencies with npm install inside the assets directory
• Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

Documentation

We use Github Wiki as the main documentation.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

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