README.md

top-repo-readme-stats

Alert:
This API uses caching by using node-cache and caches data for 10 minutes in order to prevent hitting GitHub API rate limits. As a result, the statistics might not update in real time.

This project was heavily influenced by github-readme-stats and borrows its design inspiration from it.
Special thanks to anuraghazra for the design inspiration and overall project inspiration.

Features

• Top Repositories Display: Showcases your most popular repositories based on stars.
• Caching Mechanism: Prevents excessive API requests to GitHub by caching the data for 10 minutes using node-cache.
• Easy Integration: Simple setup for embedding in your GitHub profile README.
• Customizable: Modify the API and UI as needed to fit your preferences.

Installation

To set up this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/linuxfandudeguy/top-repo-readme-stats.git
   cd top-repo-readme-stats

2. Install dependencies:

   npm install

3. Set up the GitHub API Key:

   • You need to specify a GitHub API Key in the environmental variables, and it must be specifically named GITHUB_API_KEY. Create a .env file in the root directory and add your GitHub API key like this:

   GITHUB_API_KEY=your_github_api_key

4. Add .env to your .gitignore:

   • Before publishing or republishing the repository, make sure to add .env to your .gitignore file to prevent accidentally committing sensitive information.

5. Start the server:

   npm start

   By default, the application will run on http://localhost:3000.

Deployment

To deploy this application using Vercel, you should use the Vercel CLI and ensure that you have a proper vercel.json configuration file. Here's a guide for deploying on Vercel:

1. Login to Vercel:

   • Visit vercel.com and sign in with your GitHub account.

2. Install the Vercel CLI:

   • If you haven't already installed the Vercel CLI, do so by running:

   npm install -g vercel

3. Configure vercel.json:

   • Create a vercel.json file in the root directory of your project to specify your deployment settings. Here’s an example configuration:

   {
     "version": 2,
     "builds": [
       {
         "src": "index.js",
         "use": "@vercel/node"
       }
     ],
     "env": {
       "GITHUB_API_KEY": "@github_api_key"
     }
   }

   • Replace "@github_api_key" with your actual GitHub API Key in the Vercel dashboard.

4. Deploy the project:

   • To deploy your project, use the following command:

   vercel

   • Follow the prompts to complete the deployment process.

Usage

To use this in your profile README file, ensure you’ve already created your README. If you have done that, place the following HTML snippet in the desired section of your README:

<img src="https://popularrepostats.vercel.app/popular-repos?username=your_github_username" alt="most popular repositories"/>

👀 Show examples

Customization

You can customize the appearance and functionality of the API by modifying the source code. For example, you can:

• Change the caching duration.
• Modify the API endpoints to display additional data.
• Customize the appearance of the repository cards.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

1. Fork the repository.
2. Create a new branch for your feature or bug fix:

   git checkout -b feature/new-feature

3. Commit your changes:

   git commit -m "Add some feature"

4. Push to the branch:

   git push origin feature/new-feature

5. Open a pull request.

License

This project is licensed under the MIT License. If you plan to republish or fork this repository, you must adhere to the terms of the MIT license. Additionally, ensure that .env is included in your .gitignore file to avoid exposing sensitive information.