Skip to content

aman-webdev/swiftsnif

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Swiftsnif

Shorten, Secure, and Share Your Links with Confidence

Demo

https://swiftsnif.vercel.app/

Features

  • Protect Shorten URL with Passwords
  • Shorten URLs having expiration

Usage

Using App

Usage

Using Extension

Usage

API Reference

Create short url

  POST /
Parameter Type Description
url (body) string Required. URL to be Shortened

Redirect shorten URL

  GET /:shortId
Parameter Type Description
shortId (param) string Required. URL short Id

Verify Password

  POST /verify-password?token={token}&method={method}
Parameter Type Description
token (query param) string Required. token from redirect
method (query param) string Optional. client or server
password (body) string Required. password to verify url (Body)

Run Locally

Clone the project

  git clone https://github.com/aman-webdev/swiftsnif.git

Go to the project directory

  cd swiftsnif

Docker

  docker-compose up 

Manual Setup

Client

  cd client
  npm install
  cp .env.example .env
  npm run dev

Server

  cd server
  npm install
  cp .env.example .env
  npm run dev

Extension

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

Client

VITE_BE_URL

Server

PORT

JWT_SECRET

FRONTEND_URL

MONGOOSE_URL