ricardospalves / node-url-shortener

🐢🚀 URL shortener in Node.js.

🗜️🔗 Node: URL shortener

🚧 Work in progress 🚧

URL shortener in Node.js.

Table of contents

• Technologies
• Requirements
• Installation
• Usage
• License

Technologies

API (back-end)

• Node.js with Fastify and TypeScript
• Docker and Docker Compose
• PostgreSQL
• Redis

WEB (front-end)

• React.js with TypeScript
• Tailwind CSS

Requirements

• Node.js 20.11.1 or later
• npm 10.5.0 or later
• Docker
• Docker compose

Installation

Clone this repository:

git clone [e-mail]:ricardospalves/node-url-shortener.git

API (back-end)

Access the API folder:

cd api/

Install dependencies:

npm install

WEB (front-end)

Access the WEB folder:

cd web/

Install dependencies:

npm install

Usage

API (back-end)

In the API folder, run Docker containers:

docker compose up -d

Run setup:

npm run setup

Run API application:

npm run dev

WEB (front-end)

In the WEB folder, run application:

npm run dev

In your browser access the URL: http://localhost:5173

✨ Now you can register your URLs! ✨

License

This project is free and open source software released under the MIT License.