r17x/pr-checker

check your pull request for open source immersion

Pull Request Checker

Shout out to the original author of this project Jenko, this is a modified version for the Open Source Immersion programme. This project is fan made and has no affliation with Open Source Immersion.

Happy hacking!

Requirements

• Node v10+

Recommended to use NVM

Running the app

• Generate a GitHub personal access token to ensure you don't get rate limited as often.

• Create a .env file using .env.example as an example. Or export the GitHub token as an environment variable for Node.js to use:

  • Mac/Linux: export GITHUB_TOKEN=YOUR_TOKEN
  • Windows (cmd.exe): set GITHUB_TOKEN=YOUR TOKEN
  • Windows (PowerShell): $env: GITHUB_TOKEN=YOUR TOKEN

• $ npm install

• $ npm run tailwind-gen

• $ npm start

• Point browser to localhost:5000

Want to run the API server and the frontend in their processes? Use this:

$ npm run start-frontend
$ npm run start-server

or in a single command...

$ npm run start-development