mrguima / lib-quality Goto Github PK

LibQuality is an API to measure the quality of famous open source projects like React, Angular, Vue, among others. It collects data from GitHub API, consolidate, and make them available for the end user.

• First you need Node 14+ on your environment.
• Then you have to clone this repository or download the latest version available on releases.
• Install the dependecies with npm install.
• And boot up the server npm start.

Check the swagger documentation for the API visiting http://localhost:3000/docs.

LibQuality accepts requests through the endpoint /search. Use this route with the query name. Its value should be the name of the respository you want to collet the quality metrics.

For example: http://localhost:3000/search?name=react

To avoiding reaching the maximum amount of requests provided by the GitHub API, it is highly recommended that you add your GitHub Token to the Authorization header of your requests.

LibQuality will handle the given name and, if a match is found, return the current amount of opened issues, the average days they are opened, its standard deviation and two lists of data to be used in a chart (bar, line, scatter).

LibQuality saves the searches in a database (including your public GitHub name from your token). These data will be used later to create new features. You can check the logs by visiting the /list endpoint.

To execute the unit tests of the application, run npm test.