muhsin-k / url-shortner

Creating custom URL shortener using Nodejs

URL-Shortner

Creating custom URL shortener With Nodejs

_{Built with ❤︎}

Building a custom URL shortening service like goo.gl using ExpressJs and Mongodb

Architecture

Technologies

• Back end

  • Express- Nodejs framwork for building the REST Apis
  • Mongodb- Document oriented NoSQL database
  • Mongoose- MongoDB object modeling tool
  • Short-id- Short id generator
  • Valid-url- URI validation functions
  • Nginx- Nginx is event-based and asynchronous web server.

• Front end

  • React - JavaScript library for building user interfaces.
  • React-router- Complete routing library for React
  • Materialize css- Responsive front-end framework based on Material Design

Getting Started

Clone the project

# clone it
git clone https://github.com/muhzi4u/URL-Shortner.git
cd URL-Shortner
# Make it your own
rm -rf .git && git init

Run back end

# Move to server folder
cd server/
# Install dependencies
yarn install

# Start  server
yarn run server

Run front end

# Move to client folder
cd client/
# Install dependencies
yarn install
# Start  client
yarn run start

Demo

Blog

Creating custom URL shortener with Nodejs

☑ TODO

• Front end app
• Documentation and Blog
• Add Redis for caching
• Change short code algorithm and check duplicate short codes

License

MIT

url-shortner's Issues

The site can't be reached

I clone the source code then after fixing the #1 myself, I could create a shorter url as expected.
The problem that if I access that ulr again, the page did not navigate me to the original page.

ex: http://localhost/B1xxyuXBm

undefined variable leads to server error responsed

https://github.com/muhzi4u/URL-Shortner/blob/c39ebbe6f0d338e21c21a95c6dd952d7bed124f6/server/routes/urlshorten.js#L18

NGINX not redirecting

Hi I'm trying to do the final step, which is the redirecting.

I've done the NGINX configuration:

server {
listen 8080 default_server;
listen [::]:8080 default_server;
server_name localhost;
#charset koi8-r;

    #access_log  logs/host.access.log  main;

   location / {
        root   html;
        index  index.html index.htm;
    }
    location ~* "^/[0-9a-z@]{5,15}$"  {
            rewrite ^/(.*)$ http://localhost:7000/api/item/$1 redirect;
    }

But the error I get in the browser is :
This site can’t be reached localhost refused to connect.

On Postman it's :

Could not get any response
There was an error connecting to http://localhost/kRKAtUi3r.

Any ideas what's wrong?

Redirecting

I was wondering why app.get('/api/item/:code') is present and why not app.get('/:code') to get the param from the url.

inquiry

Hi, nice project you got going here, will want to use it but any chance you'll add more code to the project especially those from your todo:

• Add Redis for caching
• Change short code algorithm and check duplicate short codes