Coder Social home page Coder Social logo

aidenybai / snip Goto Github PK

View Code? Open in Web Editor NEW
35.0 4.0 7.0 459 KB

✌️ The simple, no-bs link shortener

Home Page: https://snip.ml

License: MIT License

JavaScript 6.51% HTML 5.67% Vue 17.40% TypeScript 50.79% Shell 0.60% SCSS 19.04%
link shortener nodejs vue netlify typescript snip hacktoberfest

snip's Introduction

Snip Tweet

Netlify Status API Uptime API Ping Code Size License

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

Made with 💖 by Aiden Bai

\_ヘ(◕‿◕ ✰)

snip's People

Contributors

aidenybai avatar enkessler avatar melindachang avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

snip's Issues

Mongodb caching

Add some sort of cache to speed up requests for redirects

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.