Overview

Aster is a GitHub user analysis tool that evaluates developers' technical proficiency using open-source project data from GitHub. By analyzing project influence and developer contribution, it generates developer scores and infers developers' nationalities and areas of expertise.

Project Structure

├── go.mod
├── go.sum
├── LICENSE
├── Makefile        # some useful commands
├── README.md
├── api             # gateway/api service
├── config          # configuration files
├── docker          # docker build configuration
├── gen             # code generated by goctl rpc protoc
├── idl             # interface definition files
├── pkg             # useful funcs
├── rpc             # microservices implement
└── script          # script files

Quick Start

Preparations

Add a config/config.yaml file. For a configuration example, please refer to config.example.yaml.

Local Deployment

Startup

# Build service images
make aster-build-all
# Start environment base containers
make env-up
# Start service containers
make aster-run-all

Shutdown

# Stop environment base containers
make env-down
# Remove service containers
make aster-remove-all

Project Design

For detailed content, refer to: Aster Design Documentation

LICENSE

This project is open-sourced under the Apache-2.0 License. For details, please see the LICENSE file.