Skip to content

Latest commit

 

History

History
144 lines (103 loc) · 4.65 KB

README.md

File metadata and controls

144 lines (103 loc) · 4.65 KB
Raw

ZipLink

Shorten URLs with ease, powered by MongoDB

Try Demo

Quick start
  • You will need to have Node.js installed, this project has been tested with Node versions 12.X, 14.X and 16.X.
# clone this repo
$ git clone https://github.com/ishaanSh06/ZipLink.git
# go to ZipLink dir
$ cd ZipLink
# copy .env.template to .env (edit it according to your needs)
$ cp .env.template .env

Now, go to .env file and change the MONGO URL & DATABASE, with your own:

mongo_url = mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_HOST}:${MONGO_PORT}
DB = ZipLink # Database Name
# Install dependencies
$ npm install
# Start the server
$ npm start
API
Shorten A URL
curl -X 'GET' 'https://ziplink.cleverapps.io/api/shorten?url=https://google.com/' -H 'accept: application/json'

This produces a shortened URL, with a random alias, by a GET request to ZipLink.

Shorten A URL WITH CUSTOMIZED ALIAS
curl -X 'GET' 'https://ziplink.cleverapps.io/api/shorten?url=https://google.com/&alias=google' -H 'accept: application/json'

This produces a shortened URL, with a custom alias (in this case google), by a GET request to ZipLink.

Delete A URL WITH ACCESS KEY
curl -X 'GET' 'https://ziplink.cleverapps.io/short/delete?accessKey=${url key}' -H 'accept: application/json'

This deletes a short URL, produced from ZipLink. Make sure to provide the access key.

Moreover, you can check out the API documentation live here (Swagger).

Self Hosting
To self-host ZipLink, just follow these steps.
Live Demos https://ziplink.cleverapps.io/

qr

License 
BSD 3-Clause License

Copyright (c) 2023, Ishaan S.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Support:

ishaan328069