GitWiz

A handy portal to query public repos on multiple version control platforms.
Built with Node.js, TypeScript and JavaScript.

Prerequisites • Installation • Configuration • Run & Build • Deployment • Refs • License

Prerequisites

• Git is need to clone the repository on your machine.
• npm is needed to install packages.
• Node.js is needed to run GitWiz.

Ubuntu

Install git, Node.js and npm on your machine running Ubuntu:

$ sudo apt-get install git-core
$ sudo apt install nodejs
$ sudo apt install npm

Windows

Use the official links for downloading on Windows:

• Git
• Node.js
• npm

Run the following commands to confirm if the installation was successful:

$ git --version
$ node --version
$ npm --version 

Installation

Clone the repo and cd into the directory:

$ git clone https://github.com/shashwatah/gitwiz.git
$ cd gitwiz 

Then install the node-modules in package.json:

$ npm install

Configuration

Make a .env file and set the following environment variables:

• PORT - For the port the server is going to run on
• MORGAN_METHOD - For the method that morgan is going to log requests
• GITHUB_TOKEN - Auth Token to make requests to GitHub GraphQL API
• GITLAB_TOKEN - Auth Token to make requests to GitLab GraphQL API

Run & Build

Run the app with the following command:

$ npm start

Run the app with nodemon with the following command:

$ npm run dev

nodemon will use the config specified in nodemon.json

Open a browser and type localhost:port

Build the app(Compile TypeScript to JavaScript) with the following command:

$ npm run build

Bundle the frontend:

$ npm run buildFront

Deployment

GitWiz is currently deployed on Render.
Click here to visit.

Refs

Libraries:

• node-cache/node-cache
• ozh/github-colors

APIs:

• Github GraphQL API
• Gitlab GraphQL API

License

MIT License | Copyright (c) 2024 Kumar Shashwat