Giter Club home page Giter Club logo

javascript-sdk-boilerplate's Introduction

javascript-sdk-boilerplate Build Status

A boilerplate code template for creating a generic javascript sdk. Check out the demo.

1. Installation

You will need to have nodejs isntalled.

Clone the repository or download the zip. Or you can use the existing yeoman generator:

  • npm install -g generator-javascript-sdk-boilerplate
  • yo javascript-sdk-boilerplate

2. Getting started

  • open the command line and switch into the project folder
  • npm install
  • sudo npm install -g gulp
  • gulp to see the list of available tasks

3. Essential Gulp Tasks

  • gulp build dumps a plain and a minified file from all files in the folder src into the folder dist.
  • gulp clean removes all files in the folder dist.
  • gulp test runs the tests and linting for all files in the folder src.
  • gulp bump-patch increases the version by 0.0.1 for the last git commit and pushes the new tag to the remote repository.
  • gulp bump-minor increases the version by 0.1.0 for the last git commit and pushes the new tag to the remote repository.
  • gulp bump-major increases the version by 1.0.0 for the last git commit and pushes the new tag to the remote repository.

Web References

Tutorials to build a SDK

How others do it:

Final usage examples

Helpful sites

To support this project, please consider to donate.

This software is published under the MIT-License. See 'license' for more information.

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.