Giter Club home page Giter Club logo

rog3r's Introduction

API about a cool guy named Rogelio Alberto.

Build Status Dependency Status NPM version

NPM

Install

npm install rog3r

Usage

// ES6 modules
import rog3r from 'rog3r'

// For CommonJS you need to require the `default` instance
const rog3r = require('rog3r').default
Get Contact info

Return the content from src/me.json:

console.log(rog3r.info)
/* Return:
{
  github: rog,
  twitter: rog3r,
  ...
}
*/
Get Github activity

Get the github activity from the user specified on: src/me.json.

rog3r.githubActivity()
  .then( activity => {
    console.log(activity)
  })

Hey, I'm a cool person too!

You are right, you're a very cool person too, so you can import the CoolPerson Class and extend with your own data from src/me.json and now you can use the same methods with your own data and build the library.

Building

  1. Clone the repo: git clone https://github.com/rog/rog3r.git
  2. Install the dependencies: cd rog3r && npm install
  3. Use npm run build to build the library on the lib directory.
  • Use npm run dev to auto build the library while developing.

  • With npm test you can run the test.

  • With npm run report you can see the code coverage.


Released under the Beerware License.

forthebadge forthebadge rog3r

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.