Xerrex/url_shortener

Url Shortener

• Services that generates a shorter unique alias for Urls.

Made with:

• Python-3.8/Django
• Celery
• Redis
• Sqlite
• Docker

Get Started

Setup

Docker

• Clone the repository

  $ git clone https://github.com/Xerrex/url_shortener.git

• Change into the cloned directory

  $ cd url_shortener

• Create '.env.db' & '.env.dev' envrionment variables

  $ cp examples.envfiles/examples.env.db .env.db
  $ cp examples.envfiles/examples.env.dev .env.dev

• update the Vaules on the .env.* files

• Start the docker containers

  $ docker-compose up -d --build

• Create super user

  $ docker-compose exec web python manage.py createsuperuser

Usage

• Open localhost:8000 to access the app.
• To view the database open localhost:8080
  • use the credentials defined in '.env.db'

License

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