Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhsin-k/URL-Shortner
Creating custom URL shortener using Nodejs
https://github.com/muhsin-k/URL-Shortner
express material materialize-css mongodb mongoose nginx nodejs react react-router rest-api shortid url-shortner valid-url
Last synced: 5 days ago
JSON representation
Creating custom URL shortener using Nodejs
- Host: GitHub
- URL: https://github.com/muhsin-k/URL-Shortner
- Owner: muhsin-k
- Created: 2018-03-24T04:29:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-03T07:16:24.000Z (over 1 year ago)
- Last Synced: 2024-10-31T23:04:41.954Z (8 days ago)
- Topics: express, material, materialize-css, mongodb, mongoose, nginx, nodejs, react, react-router, rest-api, shortid, url-shortner, valid-url
- Language: JavaScript
- Homepage:
- Size: 1.27 MB
- Stars: 136
- Watchers: 11
- Forks: 47
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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](https://expressjs.com/)- Nodejs framwork for building the REST Apis
- [Mongodb](http://mongodb.com/)- Document oriented NoSQL database
- [Mongoose](https://http://mongoosejs.com)- MongoDB object modeling tool
- [Short-id](https://github.com/dylang/shortid)- Short id generator
- [Valid-url](https://github.com/ogt/valid-url)- URI validation functions
- [Nginx](https://www.nginx.com)- Nginx is event-based and asynchronous web server.
- ### Front end
- [React](https://reactjs.org/) - JavaScript library for building user interfaces.
- [React-router](https://github.com/ReactTraining/react-router)- Complete routing library for React
- [Materialize css](http://materializecss.com/)- Responsive front-end framework based on Material Design
## Getting Started
#### Clone the project
```sh
# 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](https://codeburst.io/creating-custom-url-shortener-with-nodejs-de10bbbb89c7)
## ☑ 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