# shorturly

> A simple URL shortener package

Latest version **1.0.0** (published 2024-03-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install shorturly
pnpm add shorturly
yarn add shorturly
bun add shorturly
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2024-03-04 |
| First published | 2024-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 2.8 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Dombrovskyibogdan |
| Maintainers | dombrovskyibogdan |
| Keywords | url, shortener, shorturly |

## Links

- npm: https://www.npmjs.com/package/shorturly
- Repository: https://github.com/Dombrovskyibogdan/shurly
- Homepage: https://github.com/Dombrovskyibogdan/shurly#readme
- Issues: https://github.com/Dombrovskyibogdan/shurly/issues
- npm.io page: https://npm.io/package/shorturly

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2024-03-04

## README

# Shorturly

Shurly is a simple URL shortener package for Node.js. It allows you to generate short URLs for long ones, and also expand short URLs back to their original form.

## Installation

You can install Shorturly via npm:

```bash
npm install shorturly
```

## Usage

```javascript
const Shorturly = require('shorturly');

// Create a new instance of Shorturly
const shortener = new Shorturly();

// Shorten a long URL
const originalUrl = 'https://www.example.com/very-long-url-to-be-shortened';
const shortUrl = shortener.shortenUrl(originalUrl);
console.log('Shortened URL:', shortUrl);

// Expand a short URL back to its original form
const expandedUrl = shortener.expandUrl(shortUrl);
console.log('Expanded URL:', expandedUrl);
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---
_Source: https://npm.io/package/shorturly · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._