Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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
https://github.com/lukeocodes/hacktoberfest-checker
hacktoberfest hacktoberfest-checker netlify netlify-dev netlify-functions nuxt unofficial-apps
Last synced: 3 months ago
JSON representation
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
- Host: GitHub
- URL: https://github.com/lukeocodes/hacktoberfest-checker
- Owner: lukeocodes
- License: mit
- Created: 2020-10-10T17:27:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-25T00:07:08.000Z (about 2 years ago)
- Last Synced: 2024-05-01T15:09:02.820Z (9 months ago)
- Topics: hacktoberfest, hacktoberfest-checker, netlify, netlify-dev, netlify-functions, nuxt, unofficial-apps
- Language: JavaScript
- Homepage: https://hacktoberfest.ninja/
- Size: 7.83 MB
- Stars: 16
- Watchers: 1
- Forks: 26
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Hacktoberfest Checker ([https://hacktoberfest.ninja](https://hacktoberfest.ninja))
#### _Read this in [other languages](TRANSLATIONS.md)._
[Deutsch](./.github/lang/README.de.md) |
[English](./README.es.md) |
[Português](./.github/lang/README.pt.md) |
[Española](./.github/lang/README.es.md) |
[Française](./.github/lang/README.fr.md) |
[हिंदी](./.github/lang/README.hi.md)
[한국어](./.github/lang/README.ko.md)
[](#contributors-)
Hosted at [https://hacktoberfest.ninja](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](https://www.netlify.com/products/dev/#how-it-works) to the application and Netlify Functions locally.
```bash
# 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](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) 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:
```bash
npm install
```
### Configure Environment
Create a `.env` file and add your access token to it as shown here.
```env
# .env
GITHUB_ACCESS_TOKEN=your_access_token_123
```
### Start the Local Environment
Using the Netlify Dev CLI, start the application.
```bash
$ netlify dev
```
### Does it work?
The site will be available on [localhost:8888](http://localhost:8888) by default.
## Contributing
Contributions welcome! See the [CONTRIBUTING](./CONTRIBUTING.md) file.
## License
Licensed as MIT. See the [LICENSE](./LICENSE) file.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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](https://github.com/all-contributors/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!](https://www.wwf.org.uk/updates/david-attenborough-life-our-planet)