Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 1.5 KB

README.md

File metadata and controls

60 lines (43 loc) · 1.5 KB


csus
csus

A client-side Url Shortener built with localForage and React.

example workflow

Introduction • How To Use • License

Introduction

csus is a fully client-side URL shortener, eliminating the need for any external server or database. Instead, it leverages IndexedDB, a browser-based storage solution, to store and retrieve data. This means:

  • All shortened URLs are saved locally in your browser
  • No information is transmitted over the internet or stored on remote servers
  • Shortened URLs are not shareable across devices or users (unless you export/import them)
  • Anyone with access to your browser can view and modify the shortened URLs

How to use

Simply go to the official webpage to get started, or run the app yourself by following these steps:

# Clone this repository
$ git clone https://github.com/TheWilley/csus

# Go into the repository
$ cd csus

# Install dependencies
$ npm install

# Run tests
$ npm run test

# Build app
$ npm run build

# If you want to start the app
$ npm run preview

# If you want to develop the app
$ npm run dev

License

MIT