search

vanguardvirtual / repo-ranger

Repo-Ranger is an AI-powered Github leaderboard that has no AI. It analyzes your Github activity and based on your score you win a clap 👏 or a 💩.
https://reporanger.xyz
GNU General Public License v3.0
4 stars 1 forks source link
ai github scoreboard

readme

Repo-Ranger

The AI-powered Github leaderboard.

Created by @sotergreco - Find the code for this project on Github

Repo-Ranger is an AI-powered Github leaderboard. It analyzes your Github activity and based on your score (💯) you win a clap (👏) or a poo(💩). Top 10 will get 🌟

Table of Contents

  1. Getting Started
    1. Prerequisites
    2. Installation
    3. Running the Application
  2. Features
  3. How It Works
  4. API Endpoints
  5. Contributing
  6. License
  7. Acknowledgments

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/vanguardvirtual/repo-ranger.git

  2. Install dependencies for both frontend and backend:

    pnpm install
cd api && pnpm install

  3. Set up environment variables: Create a .env file in the root directory and the api directory, and add the necessary environment variables (refer to .env.example if available).

Running the Application

  1. Start the backend server:

    cd api && pnpm run dev

  2. Start the frontend development server:

    pnpm run dev

  3. Open your browser and navigate to http://localhost:3000 (or the port specified in your configuration).

API Endpoints

All the API endpoints are on Bruno, we haven't set up Bruno yet. It is coming in the future. (Check here for updates: https://github.com/vanguardvirtual/repo-ranger/issues/11)

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments