Leaderboard for Hacktoberfest 2022.
Table of Contents
Hacktoberfest Leaderboard is an open source application that displays a list of users, ranked based on how much contributions they have made during Hacktoberfest 2022.
To get a local copy up and running, follow these simple example steps.
- Node.js
- npm
npm install npm@latest -g - yarn
npm install --global yarn
Below is an example of how you can install and set up your app.
-
Clone the repo
git clone https://github.com/PEC-CSS/Hacktoberfest-Leaderboard.git
-
Install npm packages
yarn install
-
Create a
.env.localfile in the root of the project and create an environment variable for your Github Personal Access Token.ACCESS_TOKEN=<Your personal access token>
You can refer the Github docs on how to create a personal access token.
Start the project:
yarn run devOpen http://localhost:3000 with your browser to see the result.
This project exists thanks to all the people who contribute. [Contributing].
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Be sure to read the contribution guidelines before contributing.
Distributed under the MIT License. See LICENSE for more information.
Project Link: https://github.com/PEC-CSS/Hacktoberfest-Leaderboard
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!