url-minify/README.md

113 lines
7.0 KiB
Markdown
Raw Normal View History

2022-01-27 07:00:30 +00:00
<h1 align="center">Welcome to url-minify 👋</h1>
2022-02-13 09:39:48 +00:00
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)
2022-02-13 09:39:48 +00:00
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2022-01-27 07:00:30 +00:00
<p>
<a href="LICENSE" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
</a>
<a href="https://twitter.com/BRAVO68WEB" target="_blank">
<img alt="Twitter: BRAVO68WEB" src="https://img.shields.io/twitter/follow/BRAVO68WEB.svg?style=social" />
</a>
</p>
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
<br />
2022-01-27 06:35:13 +00:00
2022-02-13 09:09:33 +00:00
<img src="https://user-images.githubusercontent.com/41448663/153746139-237f8e4d-be25-4f04-91ec-2bb3ff6f0e34.png" />
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
<br />
2022-02-13 09:39:48 +00:00
> A URL shortener build with Nextjs, ExpressJS, MongoDB
2022-01-27 07:00:30 +00:00
[![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)
2022-01-28 21:09:28 +00:00
![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)
2022-01-27 07:00:30 +00:00
2022-01-31 17:35:13 +00:00
## Getting Started
Read here :- [How to Contribute](HOW_TO_CONTRIBUTE.md)
2022-01-27 07:00:30 +00:00
## Install
```sh
2022-01-28 21:09:28 +00:00
# Installing Frontend
cd frontend && npm install
# Installing Backend
cd backend && npm install
2022-01-27 06:35:13 +00:00
```
2022-01-27 07:00:30 +00:00
## Usage
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
```sh
2022-02-13 09:39:48 +00:00
# Running Frondend
2022-01-28 21:09:28 +00:00
npm run start
# Running Backend
2022-01-27 07:00:30 +00:00
npm run start
```
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
## Author
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
👤 **BRAVO68WEB**
2022-01-27 06:35:13 +00:00
2022-02-13 09:39:48 +00:00
- Website: https://bravo68web.me
- Twitter: [@BRAVO68WEB](https://twitter.com/BRAVO68WEB)
- Github: [@BRAVO68WEB](https://github.com/BRAVO68WEB)
- LinkedIn: [@BRAVO68WEB](https://linkedin.com/in/BRAVO68WEB)
2022-01-27 06:35:13 +00:00
2022-02-13 09:09:33 +00:00
## Participations
### Current
2022-02-14 06:18:11 +00:00
- JWOC (https://jwoc.tech) <br> <img src="https://jwoc.tech/assets/img/opengraph.png" height=75px/>
2022-03-02 02:46:13 +00:00
- GSSoC (https://gssoc.girlscript.tech/) <br> <img src="https://raw.githubusercontent.com/GSSoC-Web/gssoc-assets/main/Logos/GS_logo_White.png" height=75px/>
2022-02-13 09:09:33 +00:00
### Past
2022-02-14 06:18:11 +00:00
- None
2022-02-13 09:09:33 +00:00
2022-01-27 07:00:30 +00:00
## 🤝 Contributing
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
Contributions, issues and feature requests are welcome!<br />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).
2022-01-27 06:35:13 +00:00
2022-02-13 09:39:48 +00:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
2022-02-13 10:05:21 +00:00
<table>
<tr>
<td align="center"><a href="https://github.com/para-docx"><img src="https://avatars.githubusercontent.com/u/72385299?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Dhruv Pruthi</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=para-docx" title="Code">💻</a></td>
2022-02-14 06:18:11 +00:00
<td align="center"><a href="https://github.com/chirag3003"><img src="https://avatars.githubusercontent.com/u/68195580?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Chirag Bhalotia</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=chirag3003" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/dakshgupta2002"><img src="https://avatars.githubusercontent.com/u/78641951?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Daksh Gupta</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=dakshgupta2002" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/logan4473"><img src="https://avatars.githubusercontent.com/u/69055524?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Logan</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=logan4473" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/DarkFalc0n"><img src="https://avatars.githubusercontent.com/u/59203815?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Pratyay Roy</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=DarkFalc0n" title="Code">💻</a></td>
2022-02-14 06:18:11 +00:00
<td align="center"><a href="https://github.com/luxunator"><img src="https://avatars.githubusercontent.com/u/50147562?v=4?s=55" width="55px;" alt=""/><br /><sub><b>luxunator</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=luxunator" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/aaheli8"><img src="https://avatars.githubusercontent.com/u/66815283?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Aaheli Sadhukhan</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=aaheli8" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/XxThunderBlastxX"><img src="https://avatars.githubusercontent.com/u/74706101?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Koustav Mondal</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=XxThunderBlastxX" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/himanshusanecha"><img src="https://avatars.githubusercontent.com/u/52252631?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Himanshu Sanecha</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=himanshusanecha" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/Tejas-117"><img src="https://avatars.githubusercontent.com/u/75026048?v=4?s=55" width="55px;" alt=""/><br /><sub><b>Tejas</b></sub></a><br /><a href="https://github.com/BRAVO68WEB/url-minify/commits?author=Tejas-117" title="Code">💻</a></td>
2022-02-13 10:05:21 +00:00
</tr>
</table>
2022-02-13 09:39:48 +00:00
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
2022-01-27 07:00:30 +00:00
## Show your support
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
Give a ⭐️ if this project helped you!
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
## 📝 License
2022-01-27 06:35:13 +00:00
2022-01-27 07:00:30 +00:00
Copyright © 2022 [BRAVO68WEB](https://github.com/BRAVO68WEB).<br />
This project is [MIT](LICENSE) licensed.
2022-02-13 09:39:48 +00:00
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!