LU-Overview

A dashboard to display various statistics about the members and projects of Lunatic Labs.

This project uses Angular for the frontend and a Nestjs server for the backend to connect with the APIs.

Resources

APIs

• Github
• Jibble
• Slack

Tools

• Nest
• Nest CLI
• Angular
• Angular CLI
• Angular Material
• Bootstrap

Installation

1. Follow the instructions to install an node version manager for Windows or Mac/Linux.
2. Install mongodb
3. Run

   nvm install 14.15.4
   nvm use 14.15.4

   Nvm for windows will not automatically switch versions
4. Run

   npm install -g @nestjs/cli
   npm install -g @angular/cli

5. Clone the project
6. Navigate to the server/ folder in the project and run npm install, then do the same for the client/ folder.

Running

Angular: Navigate to client/, then run ng serve. Open http://localhost:4200/

Nest: Navigate to server/, then run npm run start:dev. Open http://localhost:3000/

Both of the apps will automatically reload if you change any of the source files.

To run tests:

Angular: Navigate to client/, then run npm run test

Nest: Navigate to server/, then run npm run test

Documentation

Server

Github

Commits

/github/commits/{id}/{user}

Returns all commits from the repo specified by the id, optionally by author, limited to 1000.

Client