Skip to content

winvdaking/url-shortener

Repository files navigation

URL Shortener - Next.js & Tailwind CSS

Description

A simple and elegant URL shortener built with Next.js and Tailwind CSS. This app allows users to shorten long URLs and share them easily. The URLs are stored in a db.json file for simplicity.

Features

  • Shorten URLs with ease
  • Clean and modern user interface powered by Tailwind CSS
  • Dark mode for improved user experience
  • Easy-to-extend and scalable architecture
  • Stores URLs in a db.json file (for testing and development)

Tech Stack

  • Next.js - React framework for building server-rendered React applications
  • Tailwind CSS - Utility-first CSS framework for custom and responsive UI
  • API Routes - Server-side API logic in Next.js for handling URL shortening
  • db.json - Simple file-based database for storing URLs (for development purposes)

Installation

Prerequisites

Make sure you have the following installed:

  • Node.js (version 16.8 or above)
  • npm (comes with Node.js)

Steps to get started

  1. Clone the repository:

    git clone https://github.com/winvdaking/url-shortener-nextjs.git
    cd url-shortener

Install dependencies:

npm install

Run the development server:

npm run dev

This will start the application on http://localhost:3000.

Access the app:

Open your browser and go to http://localhost:3000 to start shortening URLs.

Explication des sections :

  • Description : Présente brièvement l'application et son but.
  • Tech Stack : Les technologies utilisées dans ce projet.
  • Installation : Les étapes à suivre pour cloner et démarrer le projet en local.
  • Configuration : Informations sur la façon dont les URLs sont stockées dans un fichier db.json, et des détails sur la configuration de Tailwind CSS.
  • Usage : Instructions sur l'utilisation de l'application pour raccourcir des URLs.
  • Future Features : Liste des fonctionnalités possibles à ajouter à l'avenir.

Winv

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published