Awesome Open Source
Awesome Open Source

URL-Shortner

Creating custom URL shortener With Nodejs

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

Architecture

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

NSGIF

Blog

Creating custom URL shortener with Nodejs

TODO

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

License

MIT


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Reactjs (72,862
Nodejs (53,956
Mongodb (14,171
Express (11,242
Rest Api (8,107
Nginx (5,150
Mongoose (4,123
React Router (3,261
Material (1,572
Materializecss (565
Related Projects