PR-Monitor is a GraphQL API built with node.js, Apollo Server and MongoDB with Mongoose as the ODM. This API helps Product Managers(PMs) and coordinators monitor the state of PRs and issues on Github and JIRA.
- Clone this repository to your local machine
- Checkout to the develop branch:
git checkout develop; - Create an account(if you don't have one) with cloud.mongodb.com and add a new database and collection.
- Create a
.envfile at the root of the application folder with the following details:
MONGO_USER=mongo_db_user
MONGO_DB=mongo_db_name
MONGO_PASSWORD=mongo_db_password
CLIENT_ID=google_client_id
CLIENT_SECRET=google_client_secret
SECRET_KEY=your_secret_key_here
GITHUB_ACCESS_TOKEN=your_access_token_from_github- Populate your env file with your database connection details(first 3 lines).
- Create a Github access token to fetch data from your repositories by following this guide.
- Get your client id and secret from Google for authentication via Google's Oauth 2 by following this guide
- With all your fields populated, you can install all requirements for the project and start the server by running:
yarn && yarn start:devon your terminal
- Latest version of node.js
- MongoDB - database
- Yarn/NPM - for dependency management
Allan Mogusu