Skip to content

KenaiiDev/url-shortener

Repository files navigation

URL SHORTENER

A simple URL shortening application built with Express and TypeScript.

Description

This project is a straightforward URL shortener developed using Express and TypeScript. It provides an interface for shortening long URLs and redirecting users to the original URLs.

Features

  • Quick and easy URL shortening.
  • Use of TypeScript for better maintainability.
  • Integration with Prisma for database management.

Prerequisites

Before you begin, ensure you have met the following requirements:

Installation

  1. Clone this repository:
git clone https://github.com/your-username/your-project.git
  1. Install dependencies
pnpm install
  1. Copy the example environment file and configure the variables as needed.
cp .env.example .env

Usage

  1. Run the application in development mode: pnpm run dev
  2. Open your browser and navigate to http://localhost:3000 to use the URL shortening interface.

Scripts

  • pnpm run dev: Start the application in development mode.
  • pnpm run build: Compile the application for production.
  • pnpm run start: Start the compiled application.
  • pnpm run lint: Run the linter to ensure code quality.
  • pnpm run test:unit: Run unit tests.
  • pnpm run test:integration: Run integration tests.

Contributions

Contributions are welcome! If you find bugs or have suggestions, please open an issue or submit a pull request.

License

This project is under the ISC License. See the LICENSE file for more details.

Contact

For any questions or comments, you can reach me at lucasvillanueva.dev@gmail.com


Enjoy shortening your URLs!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published