/Hacktoberfest-Leaderboard

Leaderboard for hacktoberfest

Primary LanguageTypeScript

Contributors Forks Stargazers Issues MIT License LinkedIn


Hacktoberfest Leaderboard

Leaderboard for Hacktoberfest 2022.

Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

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.

Built With

Getting Started

To get a local copy up and running, follow these simple example steps.

Prerequisites

  • Node.js
  • npm 
    npm install npm@latest -g
  • yarn 
    npm install --global yarn

Installation

Below is an example of how you can install and set up your app.

  1. Clone the repo

     git clone https://github.com/PEC-CSS/Hacktoberfest-Leaderboard.git

  2. Install npm packages

     yarn install

  3. Create a .env.local file 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.

Usage

Start the project:

  yarn run dev

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

Contributors

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).

Contributing

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!

  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

Be sure to read the contribution guidelines before contributing.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

acmcss@pec.edu.in

Project Link: https://github.com/PEC-CSS/Hacktoberfest-Leaderboard

Acknowledgments

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!

(back to top)