Code Monkey home page Code Monkey logo

ff's Introduction

๐‘“๐‘“

A distributed note taker and task manager.

What's the big deal?

  1. ๐‘“๐‘“ synchronizes via any file sync application, like git, Yandex.Disk, Dropbox, or Google Drive.
  2. ๐‘“๐‘“ is available offline and synchronizes without conflicts thanks to CRDT and RON.

Stability

Works on all my computers and synchronizes between them successfully. ๐‘“๐‘“'s own issues are tracked in ๐‘“๐‘“ since the first day of development. I also use ๐‘“๐‘“ for my personal tasks since the first day of development. Please feel free to test it in your environment. But no guarantees.

Project-based task management

๐‘“๐‘“ detects if it is run inside a git repository and saves notes in it. Other VCS will be supported in future. Feel free to open a ticket if you want to extend support.

Install

$ git clone https://github.com/ff-notes/ff.git
$ cd ff
$ stack install ff

Install experimental GUI

GTK version

Prerequisites

Follow https://github.com/haskell-gi/haskell-gi#installation.

Program

Mac OS:

$ export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"
$ stack install ff-gtk

Ubuntu:

$ stack install ff-gtk

Qt version

Prerequisites

Mac OS:

$ brew install qt

Ubuntu:

# apt install qt5-default

Program

$ stack install ff-qt

Completion for commands and options

Ubuntu 18.04

ff --bash-completion-script `which ff` | sudo tee /etc/bash_completion.d/ff

MacOS

ff --bash-completion-script `which ff` | sudo tee /usr/local/etc/bash_completion.d/ff

Usage

Look what ๐‘“๐‘“ can do for you

$ ff --help
Usage:  [-b|--brief] [-C|--data-dir DIRECTORY] ([-V|--version] | [COMMAND] |
        [-l|--limit ARG] ([-n|--no-tag] | [--tag TAG]...)
        [--without-tag TAG]...)
  A note taker and task tracker

Available options:
  -b,--brief               List only note titles and ids
  -C,--data-dir DIRECTORY  Path to the data dir
  -V,--version             Current ff-note version
  -l,--limit ARG           Number of issues
  -n,--no-tag              Filter items that has no tags
  --tag TAG...             Filter by tag
  --without-tag TAG...     Filter items without tag
  -h,--help                Show this help text

Available commands:
  add                      add new task or note
  agenda                   show what you can do right now [default action]
  config                   show/edit configuration
  contact                  show contacts
  delete                   delete a task
  done                     mark a task done (archive)
  edit                     edit a task or a note, using command from environment
                           variable EDITOR or program `editor`
  new                      synonym for `add`
  postpone                 make a task start later
  search                   search for notes with the given text
  show                     show note by id
  tags                     show tags of all notes
  sponsors                 show project sponsors
  track                    track issues from external sources
  unarchive                restore the note from archive
  upgrade                  check and upgrade the database to the most recent
                           format
  wiki                     show all wiki notes

Get started

Personal

To save personal notes and tasks somewhere you must configure ๐‘“๐‘“'s data directory

ff config dataDir --help

If you use Yandex.Disk, you can say just

ff config dataDir -y

Project-based

To work with a project's tasks, just run ๐‘“๐‘“ inside a VCS repository.

$ ls
.git
$ ff add ...
$ ls
.ff .git
$ git add .ff

Get some unfinished tasks

$ ff
Actual:
    * buy milk
      id 458a1456lrc-12z3opnykw, start 2018-01-10

Add new task or note

$ ff add 'learn Haskell'

Now you can find it in your agenda:

$ ff
Actual:
    * buy milk
      id 458a1456lrc-12z3opnykw, start 2018-01-10
    * learn Haskell
      id 459h2tqxutq-24nuhr86ae, start 2018-01-14

Mark task done

Marking done is actually moving to archive.

$ ff done 458a1456lrc-12z3opnykw
archived:
    buy milk
    id 458a1456lrc-12z3opnykw, start 2018-01-10

Archived tasks don't appear in an agenda:

$ ff
Actual:
    * learn Haskell
      id 459h2tqxutq-24nuhr86ae, start 2018-01-14

Developers community

We have a telegram chat ff-dev where you can ask your questions.

Alternative chat: https://gitter.im/ff-notes

ff's People

Contributors

cblp avatar willbasky avatar nick-loginov avatar deflexor avatar zyla avatar funbringer avatar setser avatar fistswanger avatar ruddy22 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.