From 104e521c844452a027acfeb10f66d08f7d89a6b5 Mon Sep 17 00:00:00 2001 From: Anushka Chauhan Date: Wed, 9 Mar 2022 10:27:31 +0530 Subject: [PATCH] Enhanced Documentation (#102) * Modified README.md * Modified README.md --- README.md | 171 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 119 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index cb937fe..43920c8 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,135 @@

Welcome to url-minify πŸ‘‹

- -[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-) - -

- - License: MIT - - - Twitter: BRAVO68WEB - -

-
+ +[![All Contributors](https://img.shields.io/badge/All_Contributors-12-orange.svg)](#-our-contributors) + + + + License: MIT + + + + Twitter: BRAVO68WEB + + +

-
+
-> A URL shortener build with Nextjs, ExpressJS, MongoDB +## πŸ“œ Overview -[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) -![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white&color=green) -![NextJS](https://img.shields.io/badge/nextjs-1.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAQAAADZc7J/AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfiBBsIJyeUHDDBAAACFUlEQVRIx52VzWtTURDFf7kvKrW1qI2BxC5EEKRWqEg+RFykQvBvkEJFFBEU6t7iQkQS3JZmI0J3giLuRJTYLlwK0i5Sgg1BMaRFupBYNLXHRVrt+06cWd15nPNm7p05E8FtUU5wkRynSbAf+EGDRcq8pcomIWaRoUSNNnJ4mxolMlhB8CRFVl3Q3b5KkaQfPMUCW4FwIbZYIOUFz7EcCt7xZXJOeJpK13AhKqTttc/3BBdi/t9dGAo9w4UoYDoEWZr/RdAkCwaLSeK764lwiKEd8m0bZIK8I0acSSwYoWZnjuuVPuiCLZbSd73XAWcONUYM4wzbiQc4xRnuEbM1qEWUiPPthhk35Ih6t8UNN8A9NTnDqDse4Rcb3OZ8GAGMGhJeBA1KDDHN4TCChKHfKy6e8JI818MI+o13PMI696kzxbkQBkPLOwPDRwrEmOZgEL5laPh/neM5l7gGfGPN+00ahiWvAoSAFg9Y4Q5pqszQ9iJYMpSDdG6RhxzhLoM85rVbzTYpe7TycX3Vio5un/o0p9+aEoppr0crg8WsPXxMX1RV4u/5pCr6rLNe8zjbScoxzn26ognb3y6rpRfuUWqS3XnKEEHZo0f6qVu+gtKFpMX1RnWN+UgadCGqKdX1TAM+ogpdyPpVreumr6xD6GLZpxl90pjvYuncReBqS+rd2tMiyaD1GLJc8xlFNxxt77ae1vsfiXkPp1Pd4OwAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTgtMDQtMjdUMDg6Mzk6MzkrMDI6MDCNfQiCAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE4LTA0LTI3VDA4OjM5OjM5KzAyOjAw/CCwPgAAAFd6VFh0UmF3IHByb2ZpbGUgdHlwZSBpcHRjAAB4nOPyDAhxVigoyk/LzEnlUgADIwsuYwsTIxNLkxQDEyBEgDTDZAMjs1Qgy9jUyMTMxBzEB8uASKBKLgDqFxF08kI1lQAAAABJRU5ErkJggg==&color=grey) +#### ➑️ Link: https://minfy.xyz -## Getting Started +#### What is URL MiniFy? +A URL shortener build with Nextjs, ExpressJS, MongoDB -Read here :- [How to Contribute](HOW_TO_CONTRIBUTE.md) +#### Technologies Used: + -## Install +
-```sh -# Installing Frontend -cd frontend && npm install +## 🎯 Getting Started -# Installing Backend -cd backend && npm install -``` +#### How to Contribute? -## Usage +Contributions, issues and feature requests are welcome! Feel free to check the [issues page](https://github.com/BRAVO68WEB/url-minify/issues). -```sh -# Running Frondend -npm run start +- Read the full guide here: [Contributing Guide](CONTRIBUTING.md) +- Detailed document on how to contribute: [How to Contribute](HOW_TO_CONTRIBUTE.md) -# Running Backend -npm run start -``` +### βœ’οΈ Summary -## Author +1. Fork this repository on GitHub. -πŸ‘€ **BRAVO68WEB** +2. Clone the forked repository in your computer. + + `$ git clone https://github.com//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 + +4. Go the folder where you want to contribute: + + `$ cd frontend` OR `cd backend` + +5. Install the dependencies and run the development server using: + + `$ npm install` + + `$ npm run start` + +#### We can start making changes now! πŸ₯³ + +6. Make your changes. Then, stage and commit them using: + + `$ git add .` + + `$ git commit -m "This is a commit message"` + +7. Push your changes to your forked repository. + + `$ git push -u origin main` + +8. 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** - Website: https://bravo68web.me - Twitter: [@BRAVO68WEB](https://twitter.com/BRAVO68WEB) -- Github: [@BRAVO68WEB](https://github.com/BRAVO68WEB) +- GitHub: [@BRAVO68WEB](https://github.com/BRAVO68WEB) - LinkedIn: [@BRAVO68WEB](https://linkedin.com/in/BRAVO68WEB) -## Participations +
-### Current +## 🎑 Participations -- JWOC (https://jwoc.tech)
-- GSSoC (https://gssoc.girlscript.tech/)
+#### Current: -### Past + + + + + +
+ +
+ GSSoC (https://gssoc.girlscript.tech/) + 		+ +
+ JWOC (https://jwoc.tech/) +
-- None +
-## 🀝 Contributing +## ✨ Our Contributors -Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/BRAVO68WEB/url-minify/issues). You can also take a look at the [contributing guide](CONTRIBUTING.md). - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): +Thanks goes to these wonderful people: @@ -102,13 +158,24 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d -## Show your support +
-Give a ⭐️ if this project helped you! +### 😽 Show your support -## πŸ“ License +Star the repository if this project helped you! ⭐️ + +### 🀝 Contributing + +Contributions, issues and feature requests are welcome! + +- Feel free to check the [issues page](https://github.com/BRAVO68WEB/url-minify/issues). +- Read the full guide here: [Contributing Guide](CONTRIBUTING.md) +- Detailed document on how to contribute: [How to Contribute](HOW_TO_CONTRIBUTE.md) + +### πŸ“ License + +Copyright Β© 2022 [BRAVO68WEB](https://github.com/BRAVO68WEB). -Copyright Β© 2022 [BRAVO68WEB](https://github.com/BRAVO68WEB).
This project is [MIT](LICENSE) licensed. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!