robertobochet/uus repository overview

⁠UUS - Uncomplicated Url Shortener

This is a url shortener written in python with flask

⁠Features

• Easily to setup
• Shortener list easily to update
• Collect daily statistics also of user-agents
• Web GUI to visualize the statistics
• Already containerized

⁠Installation

You can chose to run the service containerized or not.

⁠Docker compose

⁠Use the image on Docker Hub (recommended)

1. Download .env and docker-compose.yml files and put them in a folder.

2. Edit them to adapt the setup to your requirements(see below).

3. Run the containers.

   docker-compose up
   

   Copy

⁠Compile your own Docker image

1. Clone the whole repo.

   git clone [THIS_REPO_URL] ./uus
   cd uus
   

   Copy

2. Edit the .env and docker-compose.yml to adapt the setup to your requirements(see below).

3. Build and start the containers.

   docker-compose build
   docker-compose up
   

   Copy

⁠Configuration

You will have to provide a local or remote file in JSON format likely example.json. This can be provided as local file or remote file over http(s) protocol. You can think to versioning this file on a web service, e.g. GitLab or GitHub.

If you want to use docker-compose you have to edit .env file.

⁠Credits

In this project are used the following components:

⁠Python modules

• Flask⁠ (BSD License (BSD-3-Clause))
• simplejson⁠ (Academic Free License (AFL), MIT License (MIT License))
• gunicorn⁠ (MIT License)
• schema⁠ (MIT License)
• redis⁠ (MIT License)
• jinja2⁠ (BSD License)
• requests⁠ (Apache 2.0 License)
• APScheduler⁠ (MIT License)

⁠Web components

• Vue.js⁠ (MIT License)
• Chart.js⁠ (MIT License)
• Google Fonts⁠
• strftime for Javascript⁠ (BSD License)