Cutly API - URL Shortener Service

A modern Node.js TypeScript API for URL shortening services.

Features

• TypeScript: Full TypeScript support with strict type checking
• Express.js: Fast, unopinionated web framework
• Environment Configuration: Secure environment variable management

Prerequisites

• Node.js (v18 or higher)
• pnpm (recommended) or npm

Installation

1. Clone the repository:

git clone <repository-url>
cd cutly-api

2. Install dependencies:

pnpm install
# or
npm install

3. Set up environment variables:

cp .env.example .env

4. Edit .env file with your configuration:

PORT=5000

Development

Start development server:

pnpm run dev
# or
npm run dev

The server will start on http://localhost:3000 with hot reload enabled.

📄 License

ISC License

👨‍💻 Author

Nabed Khan