8000 GitHub - tchan247/gitpun at feat/tooltips
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

tchan247/gitpun

 
 

Repository files navigation

Gitualize

Gitualize allows you to visualize the changes in a GitHub repository.

gitualize.com

Table of Contents

  1. Usage
  2. Requirements
  3. Installation
  4. Team
  5. Contributing

Requirements

  • Node 0.12.x
  • Postgresql 9.4.x

Installation:

Running on local machine:

npm install
npm install -g gulp
gulp
node server/server.js

-### Setting up Travis CI

-1. Navigate to travis-ci and click Signup or Signin if you already have an account
-1. Mouseover your Account name on the top right and select Accounts
-1. Enable the checkbox for 'your_github_username/gitpun'
-1. Your Travis CI information can be found at https://travis-ci.org/your_github_username/gitpun upon pushing to your repo

Setting up your Database

We use PostgreSQL as our RDB.

  1. Navigate to postgressapp and follow the download instructions
  2. Open the Postgres App by clicking on the elephant on the top right of your menu bar and selecting open psql
  3. Type 'CREATE DATABASE gitpun;' and press enter to create your database
  4. Run 'node index.js' or 'nodemon index.js' from the root directory command line
  5. The app will navigate to 'postgres://127.0.0.1:5432/gitpun' where 127.0.0.1 is the default localhost and 5432 is the default port

API Use

If a repository is not in the database, the server will attempt to make a call to the GitHub API to fetch the repository.

api/user/:username/repo/:repository_name/

Returns a full commit history for the master branch of the repo

api/user/:username/repo/:repository_name?date=:date

Returns a full commit history of a repo's branch (default to master) after a given date

api/user/:username/repo/:repository_name?data=true

Will return the full details of every commit of a repo's branch (default to master)

api/commit/:commit_id

Returns the full details of a commit including lines added and deleted, files changed, and full details about what was changed in the file

Team

  • Product Owner: Dani Hu
  • Scrum Master: Devon Harvey
  • Development Team Members: Alberto D'Souza, Terry Chan

Contributing

See CONTRIBUTING.md for contribution guidelines.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0