Git Product home page Git Product logo

url-minify's Introduction

Welcome to url-minify πŸ‘‹

All Contributors

License: MIT Twitter: BRAVO68WEB




πŸ“œ Overview

➑️ Link: https://minfy.xyz

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!

url-minify's People

Contributors

03amir avatar 404-terror avatar aadityasinha-dotcom avatar aaheli8 avatar akankshat05 avatar allcontributors[bot] avatar anirban-1490 avatar anushkachauhxn avatar bravo68web avatar chirag3003 avatar dakshgupta2002 avatar danko-chan avatar darkfalc0n avatar eltociear avatar himanshusanecha avatar imgbotapp avatar logan4473 avatar lunatix01 avatar luxunator avatar mrudulkolambe avatar olaleye-blessing avatar omar-sherif9992 avatar palak-137 avatar para-docx avatar rakeshhotker avatar shruti025 avatar tejas-117 avatar xxthunderblastxx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

url-minify's Issues

[Backend] Blacklist some alias from being create

Ban custom alias keywords like the following :-

  • 404
  • dashboard
  • qr
  • credits
  • github
  • admin
  • geo
  • all
  • me
  • go
  • upload
  • download
  • link
  • about
  • tos
  • faqs

No one should be able to create backend aliases with these key words, while creating custom aliases

Fix sidebar bugs.

I would like to fix the bugs in dashboard sidebar@BRAVO68WEB mentioned.

Contributors page

Made the frontend of the contributor's page, as it an open-source helps the user to track the people who contributed to the projects.

  1. design for the page is given below
  2. it should be responsive
  3. try to make it with the same font.

image

Fix the broken UI page after minifying the URL

When we minify the URL you are automatically directed to the 404 page. Although the backend is returning the minify URL it still won't show it. we need proper UI to fix that.

Expected behavior
After minifying the URL and QR code with good UI

User Data Addition In Database

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Direct use of req.body in CRUD operations

Describe the bug
All the data being created/updated are directly using req.body, therefore if any vulnerable data is passed then there are no checks of what will be saved in the database.

To Reproduce
Steps to reproduce the behavior:

  1. Use create URL API, and pass anything other than specified parameters and it will be saved in the database.

Expected behavior
The other parameters of data being passed are also saved or an error will occur.

Make all pages responsive.

Describe the bug
The pages doesn't scale well for mobile devices.

Screenshot

I would like to work on this issue under GSSOC 2022.

Integrating the link page for the logged in user.

A user who is already logged in should be able to make access the custom link page where he can add a custom alias for the URL. the page is already built we just need to integrate it with the current application.

This will help the user to access the various feature after logging in only.

UI fix and font-size

Hey there,
On the main page, there is an extra margin at the bottom and the login button size is also not correct,
I would like to work on this issue.
could you please assign it to me under GSSoC and JWOC?

Add a start over button

After generating a minified url, on clicking a button the input box will become empty and user can enter a new URL.

Customize the 404 Page

The 404-page looks a bit more simple and the colors give a success vibe rather than an error. So I would like to make some changes.

Please assign me. @Palak-137

Login User

Is your feature request related to a problem? Please describe.
Enabled login user functionality

Additional context
image

[BACKEND] Prevent duplicate alias creation

Prevent create creation of duplicate alias creating.

Approach :-

  1. For /minify/add :- Check database if auto generated alias if present or not. If present regenerate.
  2. For /minify/add/custom :- Add an additional endpoint /minify/alias/:alias/status
    Here check in database if already present, if yes return {"success": "false"} else {"success": "true"}

Minify Button Disability Bug

Overview
Whenever there is no URL in the input box, on clicking the button it gets disabled(which forces users to refresh every time). Also when we click the cross button on the short url textbox, the QR Code still remains and the same happens when after having a code if we click on 'minify' using a blank url in the input box.

Fix

  • Remove the disability function and instead add an error popup message for blank input.
  • Fix the QR Code issue.

[BACKEND] Create a model to store Minified Urls

Create a model to store all minified URLs.

Fields :-

  • originalUrl (required)
  • minifiedAlias (required)
  • views
  • enable timestamps

Create backend/models/minifed_urls.js to store your model Schema

Animations on Home Page

I want to add some simple and cool animations on the home page UI using framer-motion. e.g - I want each letters of "URL MINIFY" to scale up and down and have some color change on hover.

Please assign me @Palak-137 ma'am.

Typography and UI

all the fonts are the same, it looks bad and unclear to user.
and UI of footer also
I want to work in this

please assign me

Enhance the documentation

Currently, the documentation was not that clear for anyone coming for the first time to the repo. You can use your writing skills to enhance the documentation of the project, like writing elaborated readme.
It can be funky and should help the readers to learn more about the project.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.