Check all your public GitHub repositories for a README.md in seconds. Try it out at https://readme.ajm.codes.
Ever wanted to see if you had any public Github repositories without a README, so you could make sure they're all your public code is well-documented? Now you can! This is the front end for an API that takes your github username and returns a list of your public repositories, as well as if a README exists for that repository.
- Git clone the project to your system and set up an instance of the API that backs this front-end
You'll need to have the API that pairs with this front end deployed on AWS. Repository for that API at this repository.
- Run this command to set up, or deploy to your favorite hosting provider like AWS Amplify or Vercel.
npm install
- Enter github username into the form on the main page.
- Hit check and a list of repositories for a given Github user, as well as whether or not they have READMEs is generated.
Deploying requires defining a few secrets in .env or the environmental variables of your hosting provider. You must define the following values
REACT_APP_README_API_KEY = API Key for your AWS API Gateway README API
- Serverless Framework - Back End
- React - Front End
- NodeJs - Server Environment
- Create React App
- @ajmarkow - Front End Adaptation
- Front end adapted from project originally built with Alex Goodwin.
- Octokit was such a pleasure to work with and indispensable to build this project.
- Serverless Stack really helped me learn building the API for this application using the serverless framework.