Shortly - URL Shortening App

Welcome! 👋

Table of contents

• Overview
  • The challenge
  • How to setup the project
  • Screenshot
  • Links
• My process
  • Built with
  • What I learned
  • Continued development
  • Useful resources
• Author
• Acknowledgments

Overview

The challenge

Shortly is a URL shortening app that allows users to shorten any valid URL at the convinience of a click absolutely free of cost 24/7.

Users should be able to:

• View the optimal layout for the component depending on their device's screen size.
• Receive an error message when the form is submitted if the input field is empty.
• See a list of their shortened links (even after refreshing the browser).
• Copy the shortened link to their clipboard in a single click.

How to setup the project

To set up the project locally, follow these steps:

1. Clone the repository using GitHub Desktop or Git Bash:

   git clone https://github.com/SartHak-0-Sach/URL-shortening-API_frontend_project.git
   

2. Open the project folder in your code editor.
3. Run the project using a live server extension or deploy it using Netlify, Vercel, or another web hosting and deployment service.

Screenshot

Links

• Solution URL: GitHub Repository
• Live Site URL: Live Site

My process

Built with

• HTML5
• CSS3
• JavaScript

You will find all the required assets in the /design folder. The assets are already optimized.

There is also a style-guide.md file containing the information you'll need, such as color palette and fonts.

What I learned

In this project I got to learn about various aspects of JavaScript like DOM manipulation and using query selectors to change inner text, inner HTML and inner style of elements as shown below-

const searhApi = async (value) => {
    if (!value || value == "") {
        return searchBar.classList.add("error");
    }
    button.innerText = "Loading...";
    button.disabled = true;
    let apiUrl = "https://api.shrtco.de/v2/shorten";
    let ApiReq = await fetch(apiUrl + `?url=${value}`);
    let ApiRes = await ApiReq.json();
    button.innerText = "Shorten it!";
    button.disabled = false;
    if (ApiRes.ok) {
        searchBar.classList.remove("error");
        const localData = JSON.parse(data);
        let obj = {
            userInput: value,
            shortenUrl: ApiRes.result.full_short_link,
        };
        localData.push(obj);
        localStorage.setItem("_html", JSON.stringify(localData));
        showHtml();
    } else {
        searchBar.classList.add("error");
        if (ApiRes.error_code == 2) {
            error.innerText = "invalid Url";
        } else {
            error.innerText = ApiRes.error;
        }
    }
};

Continued development

The continuously learning journey of a programmer never ends. This project made me realize that there are many concepts that I need to work upon including fundamentals like flex-box and its properties, to more complex concepts like working with fetch and async await in javascript. These areas are some that I think I need to work more upon in the upcoming future as they highlight some of the most significant regions of web development that are important for every developer to know of.

These key points mentioned here will help me grow accountable and consistent towards improving at writing good quality code and be a successful full stack developer one day.

Useful resources

• Harkirat Singh course notes - I have added notes of all lectures along with code and lecture insights of all weeks along with bonus lectures to help you all as much as I can.
• My development code and notes - These are my notes that I made while working on my development skills in initial days and did these courses. Make sure to star the repository if you like it.✨💫
• MDN documentation hover state for CSS - This is an amazing article which helped me finally understand hover states. I'd recommend it to anyone still learning this concept.

Author

Sarthak Sachdev

• Website - Sarthak Sachdev
• LeetCode - @sarthak_sachdev
• Twitter - @sarthak_sach69

Acknowledgments

I feel like the solutions provided on the website and the continuous doubt solving by industry experts on discord for free is something that is unmatched by anyone else and need to be acknowledged for their efforts in improving me as a developer by suggesting the best practices in your respective tech stack.

Got feedback for me?

I love receiving feedback! I am always looking to improve my code and take up new innovative ideas to work upon. So if you have anything you'd like to mention, please email 'hi' at saarsaach30[at]gmail[dot]com.

If you liked this project make sure to spread the word and share it with all your friends.

Happy coding! ☺️🚀