Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ayushbasak/chotaurl-api
a url shortener / obfuscater REST API
https://github.com/ayushbasak/chotaurl-api
chotaurl-api heroku obfuscator pastebin rest url-shortener
Last synced: 3 months ago
JSON representation
a url shortener / obfuscater REST API
- Host: GitHub
- URL: https://github.com/ayushbasak/chotaurl-api
- Owner: ayushbasak
- License: mit
- Created: 2021-05-24T15:48:25.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-24T18:30:08.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T13:31:38.834Z (5 months ago)
- Topics: chotaurl-api, heroku, obfuscator, pastebin, rest, url-shortener
- Language: JavaScript
- Homepage: https://ctlnk.herokuapp.com
- Size: 105 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - ayushbasak/chotaurl-api - a url shortener / obfuscater REST API (others)
README
# ChotaURL-api
***
### Rest API for url shortening / obfuscation and pastebin clone
## Installation
* run `$ npm install`
* create a `.env` file and add
`DB_URI=`
* run **schema.sql** to create tables for your database
You can get away by not integrating **Auth0**.
### Usage
If using localmachine, use [localhost](http://localhost:5000/)
otherwise use [ctlnk](https://ctlnk.herokuapp.com)
1. #### URL Shortener / obfuscator
* `GET https://ctlnk.herokuapp.com/q/`
* `POST https://ctlnk.herokuapp.com/q/`
```js
{
url: '',
flavor: '' [optional]
}
```
2. #### Pastebin Clone
* `GET https://ctlnk.herokuapp.com/p/`
* `POST https://ctlnk.herokuapp.com/p/`
```js
{
title: '',
content: '',
language: '' [optional]
}
```
### ErrorIds
* 1 ERROR_CREATION
* 2 ERROR_INVALID_URL
* 3 ERROR_AUTHENTICATION [Admin Authentication]
* 4 ERROR_INVALID_USER
#### My deployed version
[site](https://chotaurl.vercel.app) | [github](https://github.com/ayushbasak/chotaurl)
License: [ [MIT](LICENSE) ]