Code Monkey home page Code Monkey logo

mili's Introduction

mili: A self-hostable link shortener with QR code gen and analytics.

mili aims to be a self-hostable link shortener that's easy to setup and use with QR code generation and analytics.

Interested? You can access a demo at https://links.joshmo.dev.

How to Deploy

Shuttle

  • Use cargo shuttle init --from joshua-mo-143/mili. Follow the prompt.
  • Use cargo shuttle deploy. Wait around a bit until it's finished deploying.
  • That's it!

Regular Dockerfile deployment

  • You will need to make sure to set up the Dockerfile and make sure to pass in the following environment variables:
    • DATABASE_URL (the Postgres database URL)
    • DOMAIN_URL (the Domain URL, if you're not hosting on Railway)
  • There is currently nothing to allow working with TLS currently, so you are almost certainly going to need to deploy to somewhere like Railway that has the service behind their own reverse proxy.

Feature Roadmap

Basic Functionality

  • Link shortening
  • Custom links
  • QR Code generation
  • Superimpose logos on QR codes
  • Basic overall hit counter

Long Term

  • Make non-Dockerfile deployment work with things that aren't Railway/Shuttle
  • Vector image QR code option
  • Make QR code more customisable
  • Optional auth
  • Proper resizing for QR code logos
  • More indepth analytics per link (privacy respecting)

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.