Giter Club home page Giter Club logo

workday's Introduction

Workday

A simple CLI written in go to help with my day to day activity tracking at work.

Features

Disclaimer: The goals of this tool are aligned to my workflow and processes

  • Simple command structure
  • Plain text storage (a simple JSON)
  • Fully CLI Based
  • Very small footprint (In memory, CPU and codebase)
  • Cross platform
  • Configurable using config files

Installation

Install workday with go

go install github.com/deadpyxel/workday@latest

And the you can just start to use it:

workday

Configuration

Workday allows you to configure some options using a YAML configuration file. By default, it will search for the file under your $HOME/.config/workday/config.yaml, but you can pass the configuration file path with the --config flag. An example of a valid config file can be seen below.

journalPath: "/path/to/your/journal.json"

Running Tests

To run tests, run the following command

go test -cover -v ./...

If you want to run the benchmarks:

go test -bench=. -v ./...

Run Locally

Clone the project

git clone https://github.com/deadpyxel/workday.git

Go to the project directory

cd workday

Build the project locally

go build -o bin/

Run the app

./bin/workday

Acknowledgements

License

MIT

workday's People

Contributors

deadpyxel avatar

Watchers

 avatar  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.