https://github.com/kerolloz/most-followed-github-users-api
Top 50 most followed GitHub users in any country :octocat:
https://github.com/kerolloz/most-followed-github-users-api
followers following github github-api github-graphql go golang graphql users
Last synced: 26 days ago
JSON representation
Top 50 most followed GitHub users in any country :octocat:
- Host: GitHub
- URL: https://github.com/kerolloz/most-followed-github-users-api
- Owner: kerolloz
- Created: 2023-03-27T14:00:07.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T15:43:15.000Z (about 1 year ago)
- Last Synced: 2025-04-02T04:18:41.660Z (10 months ago)
- Topics: followers, following, github, github-api, github-graphql, go, golang, graphql, users
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Most Followed GitHub Users (API)
Returns a list of the top 50 most followed GitHub users in a particular country
## Getting Started
To get started with the project, follow these steps:
1. Clone the repository
1. Navigate to the project directory
1. Set the [required environment variables](#environment-variables)
1. Install the project dependencies using `go get ./...`
1. Build the project using `go build -o main ./app`
1. Run the project using `./main`
## Environment Variables
The project requires certain environment variables to be set in order to function properly. You can find a list of required variables in the `.env.example` file.
The project is flexible when it comes to loading the environment variables.
You can use any of the following ways to set the environment variables:
- Create a `.env` file in the root directory of the project and add your variables there. The project will automatically read these variables on startup.
- Set environment variables directly in your shell using the `export` command. For example, you could run `export GITHUB_API_TOKEN=your_token` to set the `GITHUB_API_TOKEN` variable. Note that this method will only set the variable for the current shell session.
- When running the compiled executable file, you can set environment variables inline like this: `GITHUB_API_TOKEN=your_token ./main`. This will set the `GITHUB_API_TOKEN` variable specifically for the execution of that command.
## Issues
If you encounter any issues with the project, please report them on the GitHub issue tracker.
## Contributing
If you would like to contribute to the project, please follow these steps:
1. Fork the repository
2. Create a new branch for your feature or bug fix
3. Make your changes and commit them
4. Push your changes to your forked repository
5. Open a pull request
Frontend repository: https://github.com/kerolloz/most-followed-github-users