api

API code

Folder structure

The app is split into modules. Each module (any folder directly under api/src) can have service(s) and/or controller(s).

• An example of a service is ./src/github/service.ts.
• An example of a controller is ./contributor/controller.ts.

Dependency injection

We use typedi for dependency injection. Please check their documentation.

We use it in both services and controllers.

The .env file

At a minimum, you need a .env file with this content:

NODE_ENV=development

Keep in mind that you have limited calls to the GitHub API (60 calls per hour). The FetchService does a great job of caching these calls so it doesn't unnecessarily consume the GitHub API quota. If you wish to extend the limit from 60 to 5000, simply create a GitHub Personal Access Token (make sure it has Access public repositories checked), and set it in ./api/.env like this:

GITHUB_TOKEN=Paste_Your_Token_Here
NODE_ENV=development

Note: If the README is still unclear, please create a PR with your suggested changes/additions.