Code Monkey home page Code Monkey logo

1010varun / urlshortner Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 9.0 903 KB

This open-source URL shortener project provides a simple and efficient way to create shortened URLs. Whether you're looking to share links more easily or manage URLs in your applications, this repository offers a robust solution.

Home Page: https://url-small.netlify.app/login

License: MIT License

JavaScript 54.69% HTML 0.16% CSS 39.10% Python 6.06%
cici django iwoc python react

urlshortner's Introduction

URL Shortner

This is an app used to shorten the large and clumsy-looking URLs into smaller ones.

GitHub issues GitHub forks GitHub stars GitHub license Open Source Love svg1 PRs Welcome contributions welcome GitHub contributors

Setup Instructions

Clone the repo in your local system

git clone https://github.com/1010varun/urlShortner.git

Install server

cd server
pip install -r requirements.txt

Run the development server with

python manage.py runserver

Now install client with the following steps:

Install node requirements

cd client
npm i

Run the development server with

npm run dev

Tech Stack

Client: HTML, CSS, JavaScript, Tailwind CSS, VITE, React JS

Server: Python, Django

Features

  • Shorts the given URL and will provide redirection on being called.
  • Converts clumsy-looking URLs into a small one

Contributing

Contributions are always welcome!

See contribution.md for ways to get started.

Always make a PR in the test branch

Our Amazing Contributors

Support++

This project needs your shiny star ⭐.
Don't forget to leave a star ⭐️

forthebadge made-with-javascript forthebadge

Made with ❤ by varun (@1010varun)

urlshortner's People

Contributors

1010varun avatar abhineshjha avatar dependabot[bot] avatar harmeetsingh11 avatar jiyagupta-cs avatar learnervivek avatar praptisharma28 avatar thedarkw3b avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

urlshortner's Issues

Feature: Add google OAuth in login and signup process

Feature: Google OAuth for Login and Signup

Description:
Implement Google OAuth authentication for both the login and signup processes to enhance user authentication and streamline the onboarding process.

Tasks:

Integrate Google OAuth API:

  1. Add the necessary dependencies for Google OAuth integration.
  2. Create a project on the Google Developer Console to obtain the required credentials (Client ID, Client Secret).
  3. Set up the OAuth consent screen.

Implement Google OAuth for Login:

  1. Create a "Login with Google" button on the login page.
  2. Handle the OAuth redirect/callback for successful authentication.
  3. Retrieve user information from Google and link it to the existing user account or create a new account.

Implement Google OAuth for Signup:

  1. Add a "Sign up with Google" option on the signup page.
  2. Handle the OAuth redirect/callback for successful authentication during the signup process.
  3. Retrieve user information from Google and use it to pre-fill signup forms.

Update User Database:

  1. Modify the user database schema to accommodate Google OAuth-related information.
  2. Implement the logic to store and retrieve Google OAuth details for each user.

Test and Debug:

  1. Thoroughly test the Google OAuth integration in both the login and signup processes.
  2. Handle edge cases and error scenarios gracefully.
  3. Debug and fix any issues that may arise during testing.

Update Documentation:

  1. Update the project documentation to include information on how to use the new Google OAuth features.
  2. Provide clear instructions on setting up Google OAuth credentials for the project.

Style: Enhance Login Page Background

Issue Description:
The current background on the login page is a plain white, lacking visual interest. To improve the aesthetics and create a more engaging user experience, consider adding either a gradient or a grid pattern background.

Proposed Changes:

  1. Gradient Background: Implement a subtle gradient background to add depth and visual appeal to the login page.
  2. Grid Pattern Background: Explore incorporating a grid pattern background to enhance the overall design and make the page more visually interesting.

Expected Outcome:
Upon implementing the proposed changes, the login page background will be transformed, providing a more visually appealing and engaging experience for users.

Screenshots
URL-Short

Checklist

  • I have starred the repository
  • I have checked the existing issues
  • I am willing to work on this issue
  • I am an IWOC 2.0 contributor

Code of Conduct

As this repo has not the code of conduct file ..
so i wanna work in this issue under IWOC

[Feature]: Add the pr-title-checker.yml for keeping tracks of PR.

Description
This will :
/Improved Code Organization: Consistent PR titles will enhance code organization and searchability.
/Streamlined Workflow: Integration with CodeQL and a dedicated workflow will promote efficiency and automation.
/Reduced Manual Effort: Automated checks will minimize the need for manual title review, freeing up time for development tasks.

update readme.md

Contributors section is missing in readme.md file.
I want to add it.
Kindly assign this issue to me under IWOC 2024.

[Feature]: add github action workflow for greeting contributors

Description:
The current project lacks an automated action to greet contributors. GitHub Actions can significantly enhance project automation. I propose adding a GitHub Action workflow to greet new pull request (PR) and issue creators, fostering a welcoming environment.

Proposed Changes:
Implement a GitHub Action workflow that triggers on new PRs and issues. The workflow should include a greeting message to acknowledge and appreciate the contributors for their efforts.

Expected Behavior:
When contributors create new PRs or issues, the GitHub Action should automatically trigger and post a welcoming message, acknowledging their contributions.

Checklist

  • I have starred the repository
  • I have checked the existing issues
  • I am willing to work on this issue
  • I am an IWOC 2.0 contributor

feat: add codeql workflow for `javascript` and `python`

Describe your improvement idea or feature request

The repository contains code in javascript and python , it does not have workflow for code scanning.

How would you like to see it implemented?

I aim to implement the CodeQL workflow to automate security checks. CodeQL, GitHub's code analysis engine, will identify vulnerabilities in the code and present the findings as code scanning alerts. This workflow will be activated for every push, commit, and pull request through GitHub Actions.

Would you like to work on this issue?

Yes

By submitting this issue, I have confirmed that:

  • I have starred the repo ⭐
  • I have checked the existing issues
  • I have read the Contributing Guidelines
  • I am a IWOC 2.0 contributor

Typos in README.md

There are some typos in README that needs to be fixed and correct navigation/link to contribution.md

[Feature]: Add the GitHub action workflow for greeting contributors

Description:

The current project lacks an automated action to greet contributors. GitHub Actions can significantly enhance project automation. I propose adding a GitHub Action workflow to greet new pull requests (PR) and issue creators, fostering a welcoming environment.

Proposed Changes:

Implement a GitHub Action workflow that triggers new PRs and issues. The workflow should include a greeting message to acknowledge and appreciate the contributors for their efforts.

Please assign me this issue under IWOC

QR Code Generator for URLs

Description
This project creates a simple web page using HTML, CSS, and JavaScript to generate a QR code for a specified URL.

Checklist
I have checked the existing issues.
I follow [Contributing Guidelines]
I am a IWOC'24 contributor.

Code of Conduct
I agree to follow this project's "[Code of Conduct]

[Feature]: Add GitHub Action for Automatic Assignee Assignment

Description:
Currently, it would be beneficial to have an automated workflow that assigns the pull request author as an assignee of the pull request. This streamlines the process, ensuring that the person who initiated the changes is automatically assigned.

Proposed Solution:
Implement a GitHub Action that automatically assigns the pull request author as an assignee whenever a new pull request is created.

Expected Behavior:
When a pull request is created, the GitHub Action should automatically assign the pull request author as an assignee, simplifying the assignment process.

Additional Considerations:

  • Ensure compatibility with the existing repository structure and workflows.
  • Test the action thoroughly to avoid any unintended side effects.
  • Consider any exceptions or edge cases in the assignment process.

Checklist

  • I have starred the repository
  • I have checked the existing issues
  • I have read the discussion tab thoroughly and got the project idea
  • I am willing to work on this issue
  • I am an IWOC 2024 contributor

Feat: Integrate Dependabot for Automated Dependency Updates

Describe the feature

Keeping the project's dependencies up to date can be a challenging task, especially when done manually. To streamline and automate this process, we propose integrating Dependabot.

Proposed Solution:

We need to add Dependabot to our project as it will significantly aid in keeping our dependencies current. Once activated, Dependabot will automatically submit pull requests (PRs) whenever there are outdated dependencies identified in our package.json file.

This automated approach will enhance our project's stability, security, and overall maintenance by ensuring that we are always using the latest and most secure versions of our dependencies.

Record

  • I agree to follow this project's Code of Conduct
  • I'm a IWOC24 contributor
  • I want to work on this issue

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.