sohanpaliyal / RepoRater

Rate GitHubrepos for Develop Experience (DX)

Home Page:https://repo-rater.eddiehub.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RepoRater

Screenshot 2023-12-13 at 11 00 00 Screenshot 2023-12-13 at 09 27 37

This is a Next.js project bootstrapped with create-next-app.

Technologies used

  • NextJS
  • Appwrite
  • DaisyUI (Tailwind)

Getting Started

  1. Sign up to Appwrite and create a project (free)
  2. Create database
  3. Create collections app with the attributes
    • ratings: integer
    • repos: integer
    • stars: integer
    • create empty document with 0 for each attribute
  4. Create collections ratings with the attributes
    • url: url
    • username: string
    • rating: integer
  5. Create collections repos with the attributes
    • url: url
    • description: string
    • name: string
    • votes: integer
    • rating: double
    • owner: string
    • logo: string
  6. Copy .env.example template file to .env
  7. Get you private keys from Appwrite and add them to .env template (all data are required)
  8. Run the development server with:
npm ci
npm run dev

Open http://localhost:3000 with your browser to see the result.

RepoRater Badge in your README

Add the following markdown to your README to show your RepoRater badge and link to rate your repository.

RepoRater

[![RepoRater](https://repo-rater.eddiehub.io/api/badge?owner=EddieHubCommunity&name=RepoRater)](https://repo-rater.eddiehub.io/rate?owner=EddieHubCommunity&name=RepoRater)

Change the owner and name parameters to your GitHub org/username and repository name.

Customise your RepoRater Badge

The default badge is "flat" but there are other styles if you prefer. Here are the options with examples:

style badge
flat flat
flat-square flat-square
for-the-badge for-the-badge
plastic plastic
social social

GitHub Action

Automatically comment on issues and pull requests to get votes

name: repo-rater
run-name: repo-rater (#${{ github.event.issue.number || github.event.pull_request.number }})

permissions:
  issues: write
  pull-requests: write

on:
  issues:
    types: [closed]
  pull_request:
    types: [closed]

jobs:
  repo-rater:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: xkrishguptaa/action-repo-rater@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

More details https://github.com/xkrishguptaa/action-repo-rater

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

About

Rate GitHubrepos for Develop Experience (DX)

https://repo-rater.eddiehub.io

License:MIT License


Languages

Language:JavaScript 99.8%Language:CSS 0.2%