Git Product home page Git Product logo

skillshare-shortener's Introduction

Skillshare URL Shortener

Project Requirements

  1. Node Version >= 14
  2. MySQL Database

Setup Steps

  1. Run npm i command
  2. Copy .env.example into .env
  3. Configure all relevant environment variables in .env
  4. Build the dist with npm run build
  5. Link the CLI with npm link
  6. Start the server with npm start

CLI Commands

  1. sk --help Display all the available commands.
  2. sk --shorten <url> Shortens the given URL.
  3. sk --disable <shortened url> Disables the given URL.
  4. sk --enable <shortened url> Enables a previously disabled URL.
  5. sk --stats <shortened url> Display the given URL stats.
  6. sk --list <shortened url> Display all the shortlinks for a given URL.

Warnings

  1. Environment variable TYPEORM_SYNCHRONIZE must be false in production.
  2. Environment variable TYPEORM_LOGGING is recommended to be false in production.

skillshare-shortener's People

Contributors

cedaesca avatar

Watchers

avatar avatar

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.