Skip to content

shah21/URLshortner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

URLshortner

Web app for shrink big urls

react typescript node mongodb

URLshortner is a URL shortening web app, which provides short aliases for redirection of long URLs. So we can short a long url with random values and which can use to redirect to original url. This project like mini tiny url app and help you to understand how we can short an url.

👉 View Demo 💻

Installation

Server

  1. Configure mongoDb database 📖 Connect with mongoDb atlas

  2. Clone the repo

    git clone https://github.com/shah21/URLshortner.git
  3. Install NPM packages

    cd server
    npm install
  4. Enter your API keys and Database credentials in .env 🗒️ You can find example .env file from repo

     MONGO_USER = USER_NAME
     MONGI_PASSWORD = ....
     etc...

Client (Web)

  1. Install NPM packages

    cd client
    npm install
  2. Change host ( server address ) on axios/config.ts ( if you want to run project locally )

    const host = '<address>';
    const BASE_URL = `http://${host}`;

Features 🚀

  • User Authentication
  • Material UI
  • Add and shrink url
  • Delete Url .Etc

Release History

  • 0.0.1
    • Initial Version

Meta

Muhsin Shah - @shah21 - muhsinshah21@gmail.com

Distributed under the MIT license. See LICENSE for more information.

https://github.com/shah21/Data-Bucket.git

Contributing

  1. Fork it (https://github.com/shah21/URLshortner.git/fork>)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published