url-minify/README.md

8.7 KiB
Raw Permalink Blame History

Welcome to url-minify 👋

All Contributors

License: MIT Twitter: BRAVO68WEB




📜 Overview

What is URL MiniFy?

A URL shortener build with Nextjs, ExpressJS, MongoDB

Technologies Used:


🎯 Getting Started

How to Contribute?

Contributions, issues and feature requests are welcome! Feel free to check the issues page.

✒️ Summary

  1. Fork this repository on GitHub.

  2. Clone the forked repository in your computer.

    $ git clone https://github.com/<your-username>/url-minify.git

    $ cd url-minify

  3. Add a remote (upstream) to the original project repository

    $ git remote add upstream https://github.com/BRAVO68WEB/url-minify.git

    $ git fetch upstream

    $ git checkout main

    $ git merge upstream/main

    This makes your fork up to date with the original project repo.

Installation and Usage

  1. Go the folder where you want to contribute:

    $ cd frontend OR cd backend

  2. Install the dependencies and run the development server using:

    $ npm install

    $ npm run start

We can start making changes now! 🥳

  1. Make your changes. Then, stage and commit them using:

    $ git add .

    $ git commit -m "This is a commit message"

  2. Push your changes to your forked repository.

    $ git push -u origin main

  3. Go to your forked repository on GitHub. Create a pull request from the 🔃Contribute button provided there.

    Contribute -> Open pull request -> Create pull request. (Make sure you write a detailed description of the changes you have made.)

And you're done! 🤩🤩


😊 Author

BRAVO68WEB


🎡 Participations

Past:


GSSoC (https://gssoc.girlscript.tech/)

JWOC (https://jwoc.tech/)

Our Contributors

Thanks goes to these wonderful people:


Dhruv Pruthi

💻

Chirag Bhalotia

💻

Daksh Gupta

💻

Logan

💻

Pratyay Roy

💻

luxunator

💻

Aaheli Sadhukhan

💻

Koustav Mondal

💻

Himanshu Sanecha

💻

Tejas

💻

Omar Sherif Ali

💻

Aaditya Sinha

💻

Abhay Verma

💻

😽 Show your support

Star the repository if this project helped you!

🤝 Contributing

Contributions, issues and feature requests are welcome!

📝 License

Copyright © 2022 BRAVO68WEB.

This project is MIT licensed.

This project follows the all-contributors specification. Contributions of any kind welcome!