felixkirsch / analyzemyrepo Goto Github PK

analyzemyrepo.com

Discover useful insights about your open-source repo
View Demo · Report Bug · Request Feature

analyzemyrepo.com enables you to look over any Github repository and get comprehensive details about its performance, contributors, community governance, geographic diversity, and organizational diversity.

Its primary goal is to point out repository improvement opportunities and give contributors advice on how to resolve these problems.

Besides that, analyzemyrepo.com helps you to discover cool projects thanks to weekly updated ratings and collections.

The project is built with lots of cool tecnologies. All of them are open-source.

• create-t3-app - very cool stack for Next.js
• Meilisearch - search backend
• Prefect - data orchestration
• PostgreSQL

analyzemyrepo.com uses hybrid approach to get data from GitHub. Some of the data is fetched from GitHub in realtime, some of it is fetched from Postgres where data was uploaded ahead of time using Prefect.

Still, it is possible to run analyzemyrepo.com locally and get insights about any repository. Though, not all sections will be avaliable.

You will need three main things to get started:

• npm
• GitHub API key
• Meilisearch instance with uploaded repositories names (optional)

analyzemyrepo.com can also work without Meilisearch - one would need to submit repo's name fully and correctly.

1. Get a GitHub API key
2. Clone the repo

   git clone https://github.com/CrowdDotDev/analyzemyrepo.git

3. Install NPM packages

   npm install

4. Set your GitHub API key in .env

   GITHUB_ACCESS_TOKEN_2="YOUR API KEY"

5. Set your Meilisearch credentials in .env (optional)

   NEXT_PUBLIC_MEILI_URL="YOUR MEILI INSTANCE URL"
   NEXT_PUBLIC_MEILI_SEARCH_KEY="YOUR MEILI PUBLIC KEY"

Any contributions are greatly appreciated.

If you have a suggestion that would make analyzemyrepo.com better, please fork the repo and create a pull request. You can also simply open an issue with the tag "feature request". Don't forget to give the project a star!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the Apache License 2.0. See LICENSE.txt for more information.

Igor Kotua - @garrrikkotua - [email protected]