lukeocodes / hacktoberfest-checker

Decoupled web application using Nuxt and Netlify Functions to create a way for folks to check whether a public repository is eligible and/or taking part in Hacktoberfest

Hacktoberfest Checker (https://hacktoberfest.ninja)

Read this in other languages.

Deutsch | English | Português | Española | Française | हिंदी 한국어

Hosted at https://hacktoberfest.ninja, this allows users to check if a project is taking part is Hacktoberfest.

Local Setup

As a decoupled web application, Netlify Dev is required to run the application and the Netlify function locally and use the sites check-repository feature.

Netlify Dev

Install Netlify Dev to the application and Netlify Functions locally.

# install Netlify Dev
$ npm install netlify-cli -g

Create a Personal Access Token

You need to create a GitHub Personal Access Token to be able to access the GitHub API from your local environment.

Follow the documentation and don't forget to copy the token before you leave the page (or you'll need to make two).

It ONLY needs the public_repo scope. Adding more scopes could be a security risk.

Install Packages

To install the packages required for this project, run:

npm install

Configure Environment

Create a .env file and add your access token to it as shown here.

# .env
GITHUB_ACCESS_TOKEN=your_access_token_123

Start the Local Environment

Using the Netlify Dev CLI, start the application.

$ netlify dev

Does it work?

The site will be available on localhost:8888 by default.

Contributing

Contributions welcome! See the CONTRIBUTING file.

License

Licensed as MIT. See the LICENSE file.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Luke Oliff 🤔 💻 📖 🎨	Charlie 💻 🐛	Rascal_Two 💻	Jason Chan 💻	Nicholas Carrigan (he/him) 💻 🐛 🤔 📖	Greg Holmes 📖	Alhassan 💻
Pandz18 🌍 📖	Wanja Runkel 🌍 📖 🐛	Sudipto Ghosh 🌍 📖	Álvaro Artano 🌍 📖 🐛	Shreyas Sreenivas 🐛	Manan Chawla 🐛 🎨	Gregory Gregio 💻
Leonardo 🐛 💻	Cristian Granda 🌍	João 🌍	Semyon Banser 🌍	Hongjun Yun 🌍	Ian Y. Choi 🌍

This project follows the all-contributors specification. Contributions of any kind welcome!

Trees > Tees

For Hacktoberfest participants: Please consider opting in to have a tree planted on your behalf in the Hacktoberfest Forest instead of claiming a T-shirt. We need to look after our climate!