https://github.com/jeffergonzalez/quicklink
🚀 URL shortener built with PERN Stack.
https://github.com/jeffergonzalez/quicklink
oauth2 pern-stack reactjs shadcn-ui tailwindcss typescript url-shortener vitejs-react
Last synced: 5 months ago
JSON representation
🚀 URL shortener built with PERN Stack.
- Host: GitHub
- URL: https://github.com/jeffergonzalez/quicklink
- Owner: JefferGonzalez
- License: mit
- Created: 2024-01-17T19:54:09.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-14T21:52:11.000Z (8 months ago)
- Last Synced: 2025-09-14T15:54:44.543Z (6 months ago)
- Topics: oauth2, pern-stack, reactjs, shadcn-ui, tailwindcss, typescript, url-shortener, vitejs-react
- Language: TypeScript
- Homepage: https://quicklink.jeffer.dev
- Size: 2.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QuickLink | URL Shortener
**QuickLink** is an open-source URL shortener built with the **PERN stack** (PostgreSQL, Express, React, Node.js).
It supports JWT-based authentication, cookie management, and generates both short URLs and QR codes.
The UI is modern and responsive, styled with **Tailwind CSS**.
## Table of Contents
- [📄 Overview](#quicklink--url-shortener)
- [🚀 Getting Started](#getting-started)
- [⚙️ Prerequisites](#prerequisites)
- [📦 Installation](#installation)
- [🛠️ Built With](#built-with)
- [🪪 License](#license)
## Getting Started
### Prerequisites
- [x] [Node.js](https://nodejs.org) (version 20.x or higher) installed
- [x] [pnpm](https://pnpm.io) (v10 or above) installed
- [x] [Visual Studio Code](https://code.visualstudio.com) set up with recommended extensions: ESLint, Prettier, and Tailwind CSS IntelliSense
### Installation
1. **Clone this repository**:
```bash
git clone https://github.com/JefferGonzalez/quicklink.git
```
2. **Navigate to the project directory**:
```bash
cd quicklink
```
3. **Install dependencies**:
```bash
pnpm install
```
4. **Configure environment variables**:
Create a `.env` file in the root directory and populate it using the `.env.example` file as a reference.
5. **Set up the backend**:
You also need to clone and configure the backend repository. Visit the backend repository: [JefferGonzalez/quicklink-api](https://github.com/JefferGonzalez/quicklink-api), clone it, and follow its installation steps as described in its README.
6. **Run the application**:
```bash
pnpm dev
```
7. **Access the application**:
Open your web browser and navigate to `http://localhost:5173` to view the application.
## Built with
- [React](https://react.dev/) - A JavaScript library for building user interfaces
- [Vite](https://vite.dev/) – A fast build tool and development server
- [TypeScript](https://www.typescriptlang.org/) – Superset of JavaScript for type safety
- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework for rapid UI development
- [pnpm](https://pnpm.io/) - A fast, disk space-efficient package manager
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.