8000 GitHub - Naandalist/url-shortener: Url Shortner project. A repository to contribute at Hacktoberfest 2022. 🌟 Have a great day!
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Url Shortner project. A repository to contribute at Hacktoberfest 2022. 🌟 Have a great day!

License

Notifications You must be signed in to change notification settings

Naandalist/url-shortener

 
 

Repository files navigation

URL Shortener

About:

I created this repo a long time ago (more than 3 years), made this public for Hacktoberfest! This is a very good opportunity for beginners to start their journey with open source. All PR's are welcome!

Live demo: https://url-shortener-live.herokuapp.com/

Ideas for contributing (Updating)

  • UI improvements:
    • Animations
    • Dark/Light mode toggle button
    • Github repo button
    • Fonts?
  • Migrate our front to React?
  • Add some tests?
  • Better readme?
  • Add logs?
  • Displaying the Benefits of using URL-Shortner -Safety -Reliable -Shortend
  • Adding a statistics page.
  • Add more ideas..
  • Jus 82E9 t create a PR already :)

How to run?

Locally

Step 1. Fork the Repository

Step 2. Clone the repository on your local machine

git clone https://github.com/GITHUBPROFILENAME/url-shortener.git

Step 3. Enter the command, to move to project directory

cd url-shortener

Step 4. Install the node dependencies.

npm install

Step 5. Start NPM , to make your project live

npm start

Step 6. Go on your browser and open

http://localhost:3000/

Docker

  • You can easily build your application in a docker container and run it.
docker build . -t url-shortener
docker run -p 3000:3000 url-shortener
  • Simply go to your favorite browser and visit http://localhost:3000/ to see your application.

Docker compose

  • In case you have docker installed, you can single-click deploy and test your changes by running the following and going to http://localhost:3000/ on your browser.
docker-compose up

Happy Hacking !

Contributors

License

MIT

About

Url Shortner project. A repository to contribute at Hacktoberfest 2022. 🌟 Have a great day!

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 36.0%
  • Pug 26.8%
  • CSS 17.7%
  • JavaScript 16.9%
  • Dockerfile 2.4%
  • Procfile 0.2%
0