Git Product home page Git Product logo

timepulse's Introduction

Welcome to TimePulse

OSS Time Tracker for Consultants and Contractors

This project is originally by Logical Reality Design, Inc., and was built primarily by Evan Dorn, Judson Lester, and Hannah Howard with contributions from many other current and past contractors of LRD.

Code Climate Build Status

Features Overview

TimePulse features a few key features we find useful in a team time-tracking application.

  • Both punchclock and manual entry clocking
  • Integration with GitHub and Pivotal Tracker - clocked time is associated automatically with PT tickets and with Git commits.
  • Heirarchical tree of projects, with attribute inheritance
  • Unified interface for both invoicing clients and paying subcontractors/staff
  • Invoice generation
  • Multiple customizable rates for each project
  • Workers can be individually assigned to a rate on a per-project basis

Technology

TimePulse is a Rails 3.2 + MySQL application, with a modest amount of JavaScript written with jQuery and NinjaScript. It should run fine on any platform capable of running a Ruby 1.9.3 + Rails 3.2 application, with few other dependencies.

API Integrations

TimePulse provides callback endpoints for both GitHub and PivotalTracker. If the URL at which you run TimePulse is configured in either or both services, activity (commits, ticket state changes, etc.) will be saved with your time logs. Invoice reports can then be generated which show (for example) all the git traffic and pivotal tickets that were completed during the period being billed for, and associated to the developer and/or work hours entry.

Documentation

Documentation and examples can be found at timepulse.io.

Getting Started

Assuming you have a place to deploy already set up, you'll need to:

  • Clone this repository
  • Set up deploy scripts (for Capistrano, or whatever system you prefer)
  • Copy and configure the credentials files, particularly config/database.yml, config/initializers/smtp.rb, config/initializers/session_secret.rb and config/initializers/api_keys.rb
  • Create a database
  • Deploy and seed the database
  • Log in as the initial admin user

For now, you'll probably need solid knowledge of Rails to customize and deploy this app. We're working on making it a simpler process for future users.

Contributing

Fork and Pull Request! Y'all know the drill by now. Please make sure the tests pass, and add tests for your code.

History

TimePulse was first built as an internal time-tracking application for LRD in early 2011. Since then it's grown and expanded, and in October 2013 we decided to open-source the project.

Contributors

LICENSE

TimePulse is released under a restricted license. See the accompanying LICENSE file for details.

timepulse's People

Contributors

idahoev avatar hannahhoward avatar nyarly avatar purplebaron avatar phobetron avatar jboninger avatar tomjakubowski avatar nomadicoder avatar ovargas27 avatar

Watchers

James Cloos avatar Tyrone avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.