Git Product home page Git Product logo

github-link-proxy's Introduction

Coffeekraken Github Link Proxy

Provide a simple rest API for compiling js, coffee, sass, scss, etc... files through a node server

Table of content

  1. Install
  2. Get Started
  3. Configuration
  4. CLI
  5. Contribute
  6. Who are Coffeekraken?
  7. Licence

Install

npm install coffeekraken-github-link-proxy --save-dev

Get Started

This package expose only a CLI that is used to start a small Express server. This server will make the redirections to github depending on the requested URL.

{
	"scripts": {
		"github-link-proxy" : "coffeekraken-github-link-proxy"
	}
}

Configuration

This package will read the github-link-proxy.config.js file at the root of your project. Here's the configuration references:

module.exports = {
	// server port
	port : 8181
}

CLI

This package expose a simple CLI that you can use to start the redirection server.

coffeekraken-github-link-proxy [options]

Arguments

  • -p --port : The port on which the server will run. Default 8181
  • -c --config : A path to a config file to load. Default ./github-link-proxy.config.js

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

  1. Share the love ❤️
  2. Declare issues
  3. Fix issues
  4. Add features
  5. Build web component

Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...

github-link-proxy's People

Contributors

olivierbossel avatar

Watchers

 avatar  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.