https://github.com/dannycalleri/gitly.dev

gitly.dev 🔧Check the quality of a GitHub repository 💎
https://github.com/dannycalleri/gitly.dev

community golang typescript

Last synced: 7 days ago
JSON representation

gitly.dev 🔧Check the quality of a GitHub repository 💎

• Host: GitHub
• URL: https://github.com/dannycalleri/gitly.dev
• Owner: dannycalleri
• License: gpl-3.0
• Created: 2020-05-16T18:34:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T06:12:58.000Z (almost 2 years ago)
• Last Synced: 2023-04-03T16:50:43.128Z (over 1 year ago)
• Topics: community, golang, typescript
• Language: JavaScript
• Homepage: https://gitly.dev
• Size: 12.4 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: license.txt

Awesome Lists containing this project

README

        
# gitly.dev

**gitly.dev** is a web application that **takes in input the name of a GitHub repository** and **outputs a score that tells how active a GitHub repository is**. I often found myself doing this sort of checks manually, thus I thought it would have been nice to automatize the whole process.

This is a project written for fun in **TypeScript, Go and plain JavaScript** with React for the front-end.

Since it has been written for fun, **over-engineering was the rule**.

## Architecture

The actors involved are:

- a _web application_ serving web pages written in JavaScript using Next.js (found inside the `app` folder)

- _APIs_ (TypeScript + Node.js) (found inside the `api` folder)

- a _processing_ daemon written in Go (found inside the `processing` folder)

- Redis - used as cache and PubSub system

Both the APIs and the processing Go applications are subscribed to the same Redis PubSub channels.

When the web application sends a request to calculate the score for a particular repository:

- APIs: publish a message inside the channel with a particular id that identifies the request

- APIs: record a callback for that particular request, waiting for a response

- Processing daemon: calculates the score inside a goroutine and publishes it inside the channel

- APIs: return the result to the client

I hope to publish a [sequence diagram](https://en.wikipedia.org/wiki/Sequence_diagram) soon.

### How to get better

Parallelize requests inside `api/app.ts` with `Promise.all()`, at the moment they are serial for simplicity.

Right now, as you can see in `docker-compose.production.yml` each node has its own **Redis**, this should be externalized and shared, especially if traffic will be high (unlikely).

## How to help

Open an issue, sends pull requests, you're free to contribute.

## Support