coding-blocks / shortlr Goto Github PK

An url shortner written in nodejs using PostgreSQL

HTML 4.03% JavaScript 3.01% Shell 0.52% CSS 92.42% Dockerfile 0.03%

shortlr's Introduction

shortlr

An URL shortening service written in express

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

NodeJS
Node Package Manager(NPM)
Git
PostgreSQL

Installing

A step by step series of examples that tell you have to get a development environment running

Download ZIP file or clone the repository to create your own copy.

git clone https://github.com/coding-blocks/shortlr

Move to the shortlr repository

cd ./shortlr

Install all project dependency packages via NPM

npm install

Set up PostgreSQL

If you don't have PostgreSQL setup on you machine you can download it from here.
After Installation is complete create a new PostgreSQL user shorturl with password as shorturl.
Create a new database in PostgreSQL server with name shorturl.

Start the server.

npm start

And see it working on http://localhost:4000/admin

Deploying to Heroku

heroku create
git push heroku master
heroku open

Alternatively, you can deploy your own copy of the app using this button:

Authors

Arnav Gupta -- championswimmer

See also the list of contributors who are participating in this project.

Demo

shortlr's People

Contributors

Stargazers

Watchers

Forkers

roh777 rishabhk07 rajeev-ydv vimarshc ghoomtaaaina tech4gt navendu29 abhishek97 raj-maurya tdevm ichetanbhatt shubhi007 shuboy2014 bhavyaagg apoorvaagupta asutosh7hota rahulyadav170923 hackbansu shaz13 anu0012 thenamankumar thegeekybaniya dreamerharshit astu9880 akansh97531 ananay himanshugupta1997 sagn1k mukulsaini aayusharora rijndaelsy rishabh9785 itaditya bajajerk championswimmer kalxasath shaurya2109 aryannarora agampreetsingh arvindkalra dhroov7 frunkad venomousboxer shivanggarg1998 rishabh570 kapillamba4 jboxx sagar2366 sachin235 pchsen97 adityasrivast vanshkapoor gauravrai1 sourabh1031 aggmoulik awantika1234 ishaandhamija adityastalord daggerhub greenorb007 ericbriananil sridhar4github 0xsiddhant nigelfds shivamshukla11 mukul2310 souravrao-31

shortlr's Issues

Club multiple links into one shortened link

Add possibility to password protect certain links

Prompt user when URL field is emtpy

Prompt the user to review URL field, when it is empty, instead of generating a shorlink to empty URL.

Implement 1-click heroku installation

Add a "deploy to heroku" button on the README
add app.json to configure heroku related tasks

add pagination to stats api

Design a SHORTLR logo

Make a SHORTLR Logo , can use SHORTLR word in the logo

add pagination to /admin/stats page

this is for frontend. first solve #38 so that the api gives data in pages. then solve this.

Add a COPY Button

Add a Copy Button to Copy the generated shortened URL to clipboard.

What is the license

It would be nice to know which license this code is released under. Thanks.

Find a bug / suggest a feature

Win 20 bounty points by doing either -

Find a bug

For this you have to mention expected result, and actual outcome, and post screenshots (if required) to substantiate. Vague bug reports that can't be reproduced will not be entertained

Suggest a feature

Suggest a feature that can be added. Flesh it out with technical details, and steps required to implement. Post mocks (if required) to explain the feature. It will be considered for bounty if the maintainers consider the feature suggestion valid and decide to work on it.

For either case, file a bug or suggest a feature by opening a new issue.

Adding Invisible Recaptcha

An Invisible Recapture can be added to prevent bots while generating new short url.

URL Field accepts invalid URL

The URL Field accepts any input and generates short URL for that input, URL checking can be done using a regular expression for URL (Regex)
The code below can be used to check if the input is a valid URL

let expression = /[-a-zA-Z0-9@:%_\+.~#?&//=]{2,256}\.[a-z]{2,4}\b(\/[-a-zA-Z0-9@:%_\+.~#?&//=]*)?/gi;
let regex = new RegExp(expression);

if(!siteURL.match(regex)){
    alert('Please use a valid URL');
    return false;
}

Cannot run it locally

It shows me "localhost refused to connect" error message when I try to visit https://localhost:4000/admin.

SHORTLR home page UI Changes

Changes to be made -
Add a medium size SHORTLR Logo ( use CB Logo for now ) in the middle.
Followed these two headlines -
Bigger - "A link contains much more than you think "
Smaller - "Shorten and share links with Shortlr"

Reduce form width.

Add docker configuration

Add a dockerfile so that installing shortlr via docker becomes a single-command task

When going to cb.lk/admin, always redirect to https://

Let's just do it from the frontend with a simple js line, instead of setting up nginx/apache redirects on the hosting provider.

We need to make sure the passcode never goes over http. Rest of the api can work over http, not an issue

Page not Responsive and Mobile Menu not Working

Need to be made responsive and mobile menu to be added.

Also save the base64 string in the table

update privacy policy and Terms Of Use

Append http:// if user doesn't provide

The webpage at http://cb.lk/admin has Title as "Title"

Shouldn't the title of the page be something like "URL Shortener" or "Coding-Blocks | URL Shortener" ?
Can I change it and make a PR?

add

/admin/stats is not working

fix it.
the data received in jQuery is not treated like object, but should be array.

Create a firefox extension

Like the chrome extension here https://github.com/coding-blocks/shortlr_chrome_extension
with similar functionality

regeneration of new link for same URL

http://cb.lk/39wA0
http://cb.lk/2p1Li
They both got generated for the same URL using same tab with the chrome extension.

Create Safari extension

For cb.lk/<larger than 9 digit> redirect to home

unable to start development server

I followed all the steps as explained in the readme. But after npm start server does not start, but keeps giving out this error:

internal/modules/cjs/loader.js:584
    throw err;
    ^

Error: Cannot find module '../secrets'
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:582:15)
    at Function.Module._load (internal/modules/cjs/loader.js:508:25)
    at Module.require (internal/modules/cjs/loader.js:637:17)
    at require (internal/modules/cjs/helpers.js:22:18)
    at Object.<anonymous> (/home/adityasrivast/shortlr/utils/db.js:8:17)
    at Module._compile (internal/modules/cjs/loader.js:701:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:712:10)
    at Module.load (internal/modules/cjs/loader.js:600:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:539:12)
    at Function.Module._load (internal/modules/cjs/loader.js:531:3)
    at Module.require (internal/modules/cjs/loader.js:637:17)
    at require (internal/modules/cjs/helpers.js:22:18)
    at Object.<anonymous> (/home/adityasrivast/shortlr/utils/shortner.js:5:12)
    at Module._compile (internal/modules/cjs/loader.js:701:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:712:10)
    at Module.load (internal/modules/cjs/loader.js:600:32)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `node server.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] start script.