node-url-shortener

KO | EN

gitlite — search

#react #typescript #llm #golang #android #machine-learning #rust #deep-learning #windows #awesome #pytorch #mcp #openai #open-source

node-url-shortener

(★ 32)

URL Shortener in Base58 using Node.js, Express, Sequelize, Mocha and Bootstrap

node-url-shortener 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Node URL Shortener

A URL shortener built with Express, Sequelize and MySQL, using Base58-encoded ids as short codes.

## Stack

![](https://img.shields.io/badge/node_18+-✓-blue.svg)
![](https://img.shields.io/badge/ES6-✓-blue.svg)
![](https://img.shields.io/badge/express-✓-blue.svg)
![](https://img.shields.io/badge/sequelize-✓-blue.svg)

## Screenshots

## Introduction

### What is a URL shortener?

URL shortening turns a long URL into a shorter one that redirects to the original. The short link is easier to share and remember.

### How does this project implement it?

The database stores each URL with an auto-increment numeric `id`. The short code in the path is that `id` encoded in **Base58** (alphanumeric, excluding ambiguous characters like `0`, `O`, `I`, `l`). When someone opens `/:encodedId`, the server decodes it to `id`, loads the row, and redirects to `longUrl`.

There is a **unique index** on `longUrl` so the same URL is never stored twice; concurrent `POST` requests are handled with `findOrCreate` and a fallback if a uniqueness race occurs.

## File structure

```
node-url-shortener/
│
├── api/
│   ├── controllers/
│   │   └── UrlController.js
│   ├── models/
│   │   └── Url.js
│   └── helpers/
│       └── base58.js
│
├── config/
│   ├── env/
│   │   ├── development.js
│   │   ├── index.js
│   │   ├── production.js
│   │   └── test.js
│   ├── middleware/
│   │   └── errorHandler.js
│   ├── routes/
│   │   ├── index.js
│   │   └── url.js
│   ├── database.js          * Sequelize CLI (migrations)
│   ├── express.js
│   └── sequelize.js
│
├── migrations/              * Sequelize migrations
├── seeders/
├── view/
│   ├── css/
│   ├── javascript/
│   │   └── shorten.js
│   └── index.html
│
├── test/
│   └── url.test.js
│
├── .eslintrc.json           * ESLint configuration file
├── .gitignore               * Example git ignore file
├── .sequelizerc             * Sequelize CLI paths
├── index.js                 * Entry point of our Node's app
├── LICENSE                  * MIT License
├── package.json             * Defines our JavaScript dependencies
├── package-lock.json        * Defines our exact JavaScript dependencies tree
└── README.md                * This file
```

## Requirements

- **Node.js** 18 or newer (LTS recommended)
- **MySQL** 5.7+ or 8.x

## Installation

1. Clone the repository:

```bash
git clone https://github.com/murraco/node-url-shortener.git
cd node-url-shortener
```

2. Install dependencies:

```bash
npm install
```

3. Configure the database using the variables in [Configuration](#configuration) (optional `.env` or shell exports). The files under `config/env/` only supply defaults and read from `process.env`.

## Database setup

### With Docker (MySQL 8)

```bash
docker run -d --name mysql-shortener \
  -p 3306:3306 \
  -e MYSQL_ROOT_PASSWORD=root \
  mysql:8
```

Create the databases (adjust user/password if needed):

```bash
docker exec -it mysql-shortener mysql -uroot -proot -e "
  CREATE DATABASE IF NOT EXISTS shortener_dev;
  CREATE DATABASE IF NOT EXISTS shortener_test;
  CREATE DATABASE IF NOT EXISTS shortener;
"
```

### Migrations (production and clean setups)

After MySQL is running and credentials match `config/env` (or your env vars), apply the schema:

```bash
npm run migrate
```

In **development** only, the app also runs `sequelize.sync()` on startup so tables are created if missing. **Production** does not sync on startup; run migrations before deploying.

## Configuration

| Variable | Description | Default (from env files) |
| -------- | ----------- | ------------------------- |
| `NODE_ENV` | `development`, `test`, or `production` | `development` |
| `PORT` | HTTP port | `3000` |
| `DB_HOST` | MySQL host | `localhost` |
| `DB_PORT` | MySQL port | `3306` |
| `DB_NAME` | Database name | `shortener_dev` / `shortener_test` / `shortener` by environment |
| `DB_USER` | MySQL user | `root` |
| `DB_PASSWORD` | MySQL password | `root` (override in production) |
| `PUBLIC_URL` or `BASE_URL` | Public base URL for short links (no trailing slash), e.g. `https://short.example.com` | If unset, derived from the incoming request (`req.protocol` and `Host`) |
| `TRUST_PROXY` | Set to `true` or `1` if the app sits behind a reverse proxy so `X-Forwarded-*` is honored | unset |

Copy values into a `.env` file or your host’s secret manager. The `.env` file is gitignored; do not commit real passwords.

## Running the app

- **Production-style:** `npm start` → runs `node index.js` (connects to DB, no `sync` when `NODE_ENV=production`).
- **Development with reload:** `npm run dev` → `nodemon index.js`.

Then open `http://localhost:3000` (or your `PORT`).

## API

### `GET /api-status`

Health check. **Response:** `{ "status": "ok" }`

### `POST /api/shorten`

Creates or returns an existing short link for a URL.

- **Body (JSON):** `{ "url": "https://example.com/path" }`
- **Success:** `201` — `{ "shortUrl": "<public-base>/<base58-id>" }`
- **Errors:** `400` — `{ "error": "..." }` for missing/invalid URL or non-http(s) scheme
- **Server errors:** `500` — `{ "error": "Internal server error" }`

### `GET /:encodedId`

Redirects (`302`) to the stored URL, or to the site root if the code is unknown.

## Testing

Tests use `NODE_ENV=test` (see `test/url.test.js`), the `shortener_test` database (unless overridden with `DB_NAME`), and `Url.sync({ force: true })` in a `before` hook to reset the table.

Requirements: MySQL running and the test database created.

```bash
npm test
```

`npm audit` was run after dependency updates; a few advisories may remain in transitive dev dependencies (for example Mocha). Re-run `npm audit` periodically.

## Contribution

- Report issues
- Open pull request with improvements
- Spread the word
- Reach out to me directly at <mauriurraco@gmail.com>

## License

Released under the [MIT License](LICENSE).

## Support

If this project helped you, consider buying me a coffee ☕️

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/murraco)

node-url-shortener

node-url-shortener 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

node-url-shortener

node-url-shortener 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README