Ideal Engine

Ideal Engine is a desktop application to monitor github contributions, given handles.

The project uses the following technologies

1. HTML/CSS
2. JavaScript
3. NodeJS
4. Electron(to make desktop app)

Steps to setup the app

Prerequisites

1. git
2. nodejs(install using sudo apt update && sudo apt install nodejs)

Steps to setup

1. Clone the repo git clone https://github.com/hackrush01/ideal-engine.git
2. Navigate to the folder cd ideal-engine
3. run npm install
4. run sudo npm install -g bower
5. bower install bootstrap

Application of Auth Token

1. Create a authentication token for your profile on www.github.com
2. Create a file named "auth_token" in the main directory of the project.
3. Paste the Auth token in the file created above.

Running the app

Run the app using npm start

The maintainers of this repository are(in Alphabetic Order)

1. Amit Tulshyan
2. Ankit Agarwal
3. Utkarsh Shukla
4. Vivek Modi