Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/valasek/timesheet

Self-hosted application to manage project reporting.
https://github.com/valasek/timesheet

consultant gin-gonic golang hours-reporting quasar quasar-framework reporting reporting-tool self-hosted timesheet timesheets vue

Last synced: 8 days ago
JSON representation

Self-hosted application to manage project reporting.

Host: GitHub
URL: https://github.com/valasek/timesheet
Owner: valasek
License: other
Created: 2019-01-01T02:22:24.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-12-09T16:53:52.000Z (almost 2 years ago)
Last Synced: 2024-10-16T18:59:59.477Z (23 days ago)
Topics: consultant, gin-gonic, golang, hours-reporting, quasar, quasar-framework, reporting, reporting-tool, self-hosted, timesheet, timesheets, vue
Language: Vue
Homepage:
Size: 68.8 MB
Stars: 161
Watchers: 11
Forks: 53
Open Issues: 30
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

quasar-awesome - github - hosted application to manage project reporting. Golang, Gin used on server. | 1.9.2 | (Awesome Quasar [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) / Tutorials)

README

        [![GitHub release](https://img.shields.io/github/release-pre/valasek/timesheet.svg)](https://github.com/valasek/timesheet/releases)

[![GitHub issues](https://img.shields.io/github/issues/valasek/timesheet.svg)](https://github.com/valasek/timesheet/issues)

[![Code Climate](https://codeclimate.com/github/valasek/timesheet/badges/gpa.svg)](https://codeclimate.com/github/valasek/timesheet)

[![Go Report Card](https://goreportcard.com/badge/github.com/valasek/timesheet)](https://goreportcard.com/report/github.com/valasek/timesheet)

[![Build Status](https://travis-ci.org/valasek/timesheet.svg?branch=master)](https://travis-ci.org/valasek/timesheet)

# Simple Timesheet

User-friendly, fast, and reliable web application for weekly / monthly reporting. Report consulting hours on selected projects with further segmentation via rates.

![Screencast](screenshots/screencast.gif?raw=true "Screencast")

# Supporting Simple Timesheet

Simple Timesheet is project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider:

- [Become a backer or sponsor on Patreon](https://www.patreon.com/valasek)

- [One-time donation via PayPal](https://paypal.me/StanislavValasek)

# Documentation

Read full [documentation](./server/documentation/documentation.md).

# Rationale

Reporting and billing process includes three separated steps with well-defined data which flows in between:

* **Time reporting** - all consultants

  * covered by this app - data are safe, eliminates manual errors, shows important data for consultants, data entry is as easy as possible

* **Billing preparation** (confirming/editing reported hours for billing) - project manager or administrative person

  * covered partially by this app. If you bill 1:1 with your reporting then it has all you need

  * data are available in the DB which can be exported by this app read or exported by any DB tool

* **Exporting reported and billed hours** in the internal accounting system for the invoicing to the clients and consultants - salaries

  * not covered by this app

  * data are available in the DB which can be exported by this app read or exported by any DB tool

# Contributing

I would love your help! Before submitting a PR, please read over the [Contributing](CONTRIBUTING.md) guide.

To help you to get started you can read how to [run the Timesheet from the source](https://github.com/valasek/timesheet/wiki/Run-the-Timesheet-from-the-source).

Here's a couple of areas that need some love:

* **Import/Export plugins** - do you like functionality but want to integrate with your company billing SW? Create an issue and if you can submit PR.

* **Javascripts** - I'm no JS wizz, I'm sure the Javascript code in ui/src could be improved/simplified/tested. * **Documentation** - Typo? Does something not make sense? Could it be worded better? Please help!

* **Test Coverage** - Would love to get coverage over 80%, fontend and backend.

# Standing on the shoulders of giants

[Go](https://golang.org/), [Gin web framework](https://github.com/gin-gonic), [Vue](https://vuejs.org/), [Quasar](https://quasar.dev/), [PostgreSQL](https://www.postgresql.org/) and [MySQL](https://www.mysql.com/)

## Go Backend

- [Gin web framework](https://github.com/gin-gonic)

- [Gorm](https://github.com/jinzhu/gorm) (with [PostgreSQL](https://www.postgresql.org/) or [MySQL](https://www.mysql.com/) persistence)

- [Logrus](https://github.com/sirupsen/logrus), [Cobra](https://github.com/spf13/cobra), [Viper](https://github.com/spf13/viper), [Now](https://github.com/jinzhu/now), [lumberjackrus](https://github.com/orandin/lumberjackrus), [Cron](https://github.com/robfig/cron)

## JavaScript Frontend

- [Vue.js](https://vuejs.org/) spa client with webpack

- [Quasar](https://quasar.dev/)

- [Axios](https://github.com/axios/axios), [date-fns](https://date-fns.org/)