Microservice for filiosoft.org
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.eslintrc.js
.gitignore
LICENSE
README.md
index.js
package-lock.json
package.json
secrets.example.yml
serverless.yml

README.md

github-repos

Microservice to cache and expose GitHub projects for this page. Built after zeit/github-repos.

Usage

Simply install the dependencies:

npm install

Create the secrets.yml:

echo "TOKEN: github-api-token" > secrets.yml

And run the server:

npm run dev

API

GET /

200: Returns a list of projects as follows

[
  {
    "name": "project-name",
    "description": "The description woot",
    "url": "https://github.com/filiosoft/test",
    "stars": 3040,
    "forks": 0,
    "fork": false
  }
]

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!

Authors

Some of the code is adapted from zeit/github-repos.