README.md

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