aidenybai / snip

✌️ The simple, no-bs link shortener

Snip

A faster, cleaner, no-bs link shortener, skipping the not-so-great privacy reputation of marketing centric link shorteners (cough adfly).

Goals

We adapt Chromium principles to help us drive product decisions:

• Speed: Snip has low performance overhead and is compressed with deflate and gzip.
• Security: Snip is secured with 128-bit SSL and no user data is stored (privacy baby)
• Sustainability: Snip relies on a 7 day TTL to keep the service going in good health.
• Simplicity: Snip provides a high-level interface that’s easy to use, understand, and debug.

Getting Started

Installation

git clone https://github.com/aidenybai/snip.git
cd snip

To view client/server installation instructions, open the respective directories.

client | server

Note: You will need at least NodeJS 10.18.1+, VSCode 1.44+, Yarn 1.17.3+ and MongoDB 3+. You will also need to configure .env variables before launching.

FAQ

Q: Who maintains Snip?

Aiden Bai maintains the project, but we'd love your help and expertise on the project! Feel free to fork and make changes, if you like the project, drop a ⭐!

Q: What is the character limit for links?

100,000 characters after normalization by normalize-url. If your link isn't initially provided correctly, the normalization algorithm may increase your link character count.

Q: Is there a expiry or TTL for snips?

Yes, the TTL for snips is 7 days before permanent deletion.

Q: I'm recieving ReferenceError: yarn is not defined whenever I try to use Yarn

You need to install yarn first. Go to their website and follow instructions.

Q: What's the difference between yarn start and yarn serve?

Our project has two environments: Production and Development. The production environment is used when it is actually hosted, an example is https://snip.ml. The development environment shows more "developer" metrics, helping you to debug, but is not suitible for production.

yarn start # production

yarn serve # development

Q: I'm recieving Error: Cannot find module 'example' whenever I start the project

You need to install the packages with the command below.

yarn

Useful Links

• The website hosts the production version of the website.
• Our Github Repository contains the most updated code.
• Our Producthunt Page shows the latest feedback from indie makers.

Made with 💖 by Aiden Bai

＼＿ﾍ(◕‿◕ ✰)