Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsuyog2/sequelize-shorten-url
sequelize-shorten-url is a Node.js package that provides URL shortening functionality using Sequelize ORM. It allows you to shorten URLs, track the number of clicks, and retrieve statistics, all while leveraging your own database configuration.
https://github.com/jsuyog2/sequelize-shorten-url
click-tracking npm-package sequelize short-url short-urls url-shortener
Last synced: 2 months ago
JSON representation
sequelize-shorten-url is a Node.js package that provides URL shortening functionality using Sequelize ORM. It allows you to shorten URLs, track the number of clicks, and retrieve statistics, all while leveraging your own database configuration.
- Host: GitHub
- URL: https://github.com/jsuyog2/sequelize-shorten-url
- Owner: jsuyog2
- Created: 2021-07-28T06:16:24.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T06:54:56.000Z (5 months ago)
- Last Synced: 2024-11-09T06:19:36.504Z (3 months ago)
- Topics: click-tracking, npm-package, sequelize, short-url, short-urls, url-shortener
- Language: JavaScript
- Homepage: https://github.com/jsuyog2/sequelize-shorten-url
- Size: 320 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sequelize-shorten-url
`sequelize-shorten-url` is a Node.js package that provides URL shortening functionality using Sequelize ORM. It allows you to shorten URLs, track the number of clicks, and retrieve statistics, all while leveraging your own database configuration.
## Features
- Shorten URLs and store them in a database.
- Track the number of clicks on each shortened URL.
- Retrieve original URLs and statistics.
- Compatible with any database supported by Sequelize (e.g., MySQL, PostgreSQL, SQLite).
## Badges
## Installation
Install the package via npm:
```bash
npm install @jsuyog2/sequelize-shorten-url
```
## Usage
### Initialize the Package
You can initialize the package by providing your Sequelize configuration or an existing Sequelize instance.
```javascript
const { Sequelize } = require('sequelize');
const createShortener = require('@jsuyog2/sequelize-shorten-url');
// Example: Using a Sequelize configuration object
const sequelize = new Sequelize('database', 'username', 'password', {
host: 'localhost',
dialect: 'mysql', // or 'sqlite', 'postgres', etc.
});
const shortener = createShortener(sequelize);
```
### Shorten a URL
```javascript
shortener.createShortUrl('https://example.com').then((result) => {
console.log('Shortened URL:', result.shortUrl);
});
```
### Retrieve the Original URL and Increment Clicks
```javascript
shortener.getOriginalUrl('shortUrl').then((result) => {
if (result) {
console.log('Original URL:', result.originalUrl);
console.log('Clicks:', result.clicks);
} else {
console.log('Short URL not found');
}
});
```
### Get URL Statistics
```javascript
shortener.getUrlStats('shortUrl').then((stats) => {
if (stats) {
console.log('Original URL:', stats.originalUrl);
console.log('Clicks:', stats.clicks);
} else {
console.log('Short URL not found');
}
});
```
## Database Configuration
This package is designed to work with any database supported by Sequelize. You can use your own database configuration as shown in the examples above.
### Model
The package uses a `ShortenUrls` model with the following fields:
- `originalUrl` (STRING): The original URL to be shortened.
- `shortUrl` (STRING): The shortened version of the URL.
- `clicks` (INTEGER): The number of times the shortened URL has been clicked.
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.
## License
This package is licensed under the ISC License. See the [LICENSE](LICENSE) file for details.
## Author
Created by Suyog Dinesh Jadhav.