deathnote-contributions-feeder

Death Note off chain service to watch github contributions and update associated smart contract state on StarkNet.

⚠️ WARNING! ⚠️

This repo contains highly experimental code. Expect rapid iteration.

🎟️ Description

🎗️ Prerequisites

1. Setup your environment

Create the .env file with the correct environment variables. Copy the .env.example file and modify the values according to your setup.

2. Start the docker container

Make sure docker compose is installed (see Installation instructions).

docker-compose -f scripts/docker/dev/docker-compose.yml up -d

3. Setup the database

Make sure Diesel CLI is installed (see installation instructions):

Then, use Diesel to initialize the data model and the database:

source .env
diesel setup
diesel migration run

📦 Installation

To build the project, run the following command:

cargo build

🔬 Usage

Below are some examples of usage.

Analyze a single repository

cargo run --bin watch_repo bitcoin bitcoin 

🌡️ Testing

cargo test

🫶 Contributing

📄 License

deathnote-contributions-feeder is released under the MIT.