Giter VIP home page Giter VIP logo

intern0t / oblique Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 0.0 182 KB

Oblique is a URL shortening service written in NodeJS and Javascript to make calls to an API endpoint, includes both Frontend & the backend + Bash/Python scripts.

Home Page: http://o.prashant.me

License: GNU General Public License v3.0

JavaScript 5.93% CSS 91.24% HTML 1.74% Dockerfile 0.07% Python 0.15% Shell 0.88%
lowdb backend frontend clipboardjs url-shortener javascript jquery promises opensource nodejs

oblique's Introduction

Oblique

URL Shortener that makes use of LowDB to store & search for saved URLs.

Frontend

  • Copy function, let's try DOM way but ClipboardJS is the last resort.
    • Add Copy button next to the userInput field.
  • Add favicon.

Third-party used

  1. BulmaCSS
  2. ClipboardJS
  3. Icons8 for favicon.

Scripts

These scripts can help you connect and make direct calls to the API Endpoint, needs some configuration. These scripts require you to have xclip installed for clipboard interaction, and jq for JSON parsing.

  1. oblique.py, oblique.sh

    Accepts longurl parameter, ./oblique.py longurl_here.

  2. shorten

    A bash script written to access the backend privately configured in order to generate different shortened link compared to the backend. Accepts longurl parameter as the first argument like ./shorten longurl or simply execute the script ./shorten.

Demo of shorten

Backend

Endpoints

Let me use the term BACKEND to denote the server's root domain.

  • POST - BACKEND/create

    link = string (long URL) auth = string (pms by default for now)

  • POST - BACKEND/find

    shortLink = string (shortened URL id)

  • POST - BACKEND/clear (Not quite sure if I want to implement it)

    auth = string (admin key to clear the database)

Modules Used

  1. LowDB
  2. Bluebird Promise
  3. Openode for hosting the backend, not anymore! :D

Thanks to

  1. Random Words API

Fork in a river Fork in a river

Courtesy to @rafasc & @rewt at Freenode#git.

oblique's People

Contributors

intern0t avatar

Stargazers

 avatar  avatar

Watchers

 avatar  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.