An application to make working with and handling links easier.
Scissor allows you to take a long URL and create a shortened alias that when accessed as a path on the platform, redirects you to your original URL.
Scissor also allows you to customize the alias generated. Users can choose a custom alias that reflects their brand or content.
This is particularly useful for individuals or small businesses who want to create branded links for their operations.
Scissor automatically generates a QR Code image for every shortened alias.
Users can download the QR code image and use it in their promotional materials and/or on their website.
Scissor allows you to see the history of alias's you’ve created so you can easily find and reuse them.
Scissor provides basic analytics that allows you to track your alias's performance.
Users can see how many clicks and scans their alias's has received.
Analytics are provided on each hit where a hit is a click or scan.
These are the details of each hit:
- Date and time of the
hit - IP address of
hit - Referrer (this is the name of the website the link was clicked from)
- Location (country and city) of
hit - Internet Service Provider of the
hit
You can create a new collection on MongoDB Atlas
Or you can also install MongoDB and make sure it's running locally
If you use a unix/linux system (i.e. Ubuntu or Mac systems) you can just install Redis and run it locally.
If you're on the Windows spectrum though you will have to use a managed Redis Server. I suggest Redis Labs though as it's the official one.
After your mongodb and redis are setup you can rename the .env.sample file to .env and put in appropriate values for the variables.
Here's how the .env.sample looks like currently:
MONGODB_URI="MONGODB_URI"
SESSION_SECRET="SESSION_SECRET"
REDIS_PASSWORD="REDIS_PASSWORD"
REDIS_HOST="REDIS_HOST"
REDIS_PORT="REDIS_PORT"Put in the appropriate fields from your services (MongoDB and Redis) and add an appropriate session secret.
Make sure you have NodeJS installed and type in npm install in the terminal of your root directory.
After that, type in node ./dist/index.js and you should get something like this in your terminal:
This means your app is running locally and you can access it on http://localhost:8080