Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.02 KB

readme.md

File metadata and controls

47 lines (32 loc) · 1.02 KB
Raw

github-repos

Microservice to cache and expose GitHub projects for The Palmer Group

Usage

Simply install the dependencies:

npm install

And run the server:

npm run dev

API

GET /

200: Returns a list of projects as follows

[
  {
    "name": "project-name",
    "description": "The description woot",
    "stars": 3040,
    "url": "https://github.com/palmerhq/test"
  }
]

Contributing

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Follow the usage section
  3. Start making changes and open a pull request once they're ready!

You can use npm test to run the tests and see if your changes have broken anything.

Original Authors