Project-x

Use github username in login page to get your repositories.

Tech Stack

Frontend

• React

Backend

• NestJS
• TypeORM
• MySQL

CRON

• NodeJS
• Cron - cron command-line utility is a job scheduler on Unix-like operating systems. Users who set up and maintain software environments use cron to schedule jobs, also known as cron jobs, to run periodically at fixed times, dates, or intervals.

How to start redis

# start redis
sudo service redis-server start

How to run Backend

# start server
npm start or npm run start:dev in development

How to start cron

# start cron
npm start

How to run Frontend

# start server
npm start

How to test

Install Postman

API endpoints

HTTP route prefix : http://localhost:3000/

API endpoints summary

USER

Route	Method	Description
/user/login	post	to get access token

Repo

Route	Method	Description
/post/getRepo	GET	read repo (Authentication needed)

POST http://localhost:3000/user/login

HTTP Request Body Example

{
    "username" : "uk0724",
    "password" : "*****"
}

HTTP Response Body Example

{
    "access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ik5hcmF5YW5AZ21haWwuY29tIiwiaWF0IjoxNjUzODg3NjExLCJleHAiOjE2NTM4ODgyMTF9.GdZBS5LbxPllp-osTSYz6CURZC3eH3a8p7kn0Hx18JE"
}

get http://localhost:3000/repo/getRepo

TOKEN

BEARER TOKEN in authorization header

HTTP Request Body Example

Repo details will be fetched after logingin

HTTP Response Body Example

{
    {
    [
        {
            "id": "400062373",
            "username": "uk0724",
            "repo_name": "lab-cricpro-scoreboard"
        }
    ]
}
}

'

SCREENSHOTS

UML Diagram

System Design

Flowchart

Login page

Login page if invalid credential are entered

DASHBOARD PAGE

DASHBOARD video

Untitled.mp4