Giter VIP home page Giter VIP logo

url_shortener's Introduction

UrlShortener

URL shortener application, in the same vein as bitly and tinyurl.

Please refer to notes.txt for more detailed information about the app's design.

Setup

Prerequisites

Installing Elixir

We recommend using asdf to manage the Erlang/Elixir versions installed in your system. Please follow these instructions to install the necessary plugins before installing Elixir.

Docker

This project uses Docker to manage the app's dependencies. Please follow these instructions to install the Docker runtime in your machine.

Initial setup

You can choose to run the app via Docker compose or in your host machine. If you want to run it via Compose, run make docker-run and the container shall be started.

But if you prefer to run the app in your host machine, run make server instead. This will require that you run make setup first, so the project is correctly configured in your machine.

Note: Remember to check your .env file so the environment variables are correctly configured for either docker or the local server. Some variables may need adjustment, like the DATABASE_URL one.

Now you can visit localhost:8080 from your browser.

Configuration

The app uses environment variables for runtime configuration. They can be configured locally by edditing the .env file created once you run make setup.

url_shortener's People

Contributors

gerson-scanapieco avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.