Prepared for first release

- Creating db file in home dir or DB_FILE env variable
- Updated README with usages details
- Added GIF screencast

Author: ajaxray

.gitignore

@@ -13,5 +13,6 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+builds/
 /geek-life
 /geek-life.db

README.md

@@ -1,2 +1,135 @@
-# geek-task
-Todo List Manager for Geeks
+geek-life - The CLI Task Manager for Geeks :technologist:
+=========
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Go Report Card](https://goreportcard.com/badge/github.com/ajaxray/geek-life)](https://goreportcard.com/report/github.com/ajaxray/geek-life)
+
+
+:superhero: Command Line hero?     
+:computer: Live with the dark terminal?  
+:memo: Think in Markdown?  
+
+**Finally!** A full featured task manager for YOU! 
+
+![Geek-life overview](screens/geek-life_v1.gif "Geek-life overview")
+
+### Highlights
+
+- For ninjas - do things faster with keyboard shortcuts
+- Markdown lovers, feel at :house:! You'll see markdown everywhere.
+- Full featured (almost) - Projects, Tasks, due-dates, task notes...
+- A <4MB app that takes <1% CPU and ~7MB memory <sup>1</sup> - how much lighter you can think?
+- Task note editor with markdown syntax highlighting<sup>2</sup>
+- Full mouse support
+
+### Roadmap
+- [x] Create Project
+- [x] Delete Project
+- [ ] Edit Project
+- [x] Create Task (under project)
+- [x] Set Task due date (as `dd-mm-yyyy`) with shortcut
+- [x] Set Task due date with quick input buttons (today, +1 day, -1 day)
+- [x] Tasklist items should indicate status (done, pending, overdue) using colors 
+- [x] Shortcut for Adding new Project and Task
+- [x] Global shortcuts for jumping to Projects or Tasks panel anytime
+- [x] Cleanup all completed tasks of project
+- [x] Task note editor should syntax highlight (markdown) and line numbers  
+- [x] Status bar for common shortcuts
+- [x] Status bar should display success/error message of actions
+- [x] Status bar may display quick tips based on focused element
+- [ ] Dynamic lists 
+    - Today - Due Today and overdue 
+    - Upcoming - Due in one week
+    - Someday - No due date
+- [ ] [Havitica](https://habitica.com/)<sup>3</sup> integration - Use it as Habitica client or use Habitica for cloud backup
+- [ ] Time tracking
+
+### Ready for action (installing and running)
+
+It's just a single binary file, **no external dependencies**. 
+Just download the appropriate version of [executable from latest release](https://github.com/ajaxray/geek-life/releases) for your OS. 
+Then rename and give it permission to execute. For example
+```bash
+mv geek-life_linux-amd64 geek-life  
+sudo chmod +x geek-life
+```
+
+If you want to install it globally (run from any directory of your system), put it in your systems $PATH directory.
+```bash
+sudo mv geek-life /usr/local/bin/geek-life
+```
+Done! 
+
+## Keyboard shortcuts
+
+Some shortcuts are global, some are contextual. 
+Contextual shortcuts will be applied according to focused pane/element.  
+You'll see a currently focused pane bordered with double line. 
+
+In case writing in a text input (e,g, new project/task, due date), you have to `Enter` to submit/save. 
+
+| Context | Shortcut | Action |
+|---|:---:|---|
+| Global | `p` | Go to Project list |
+| Global | `t` | Go to Task list |
+| Projects | `n` | New Project |
+| Tasks | `n` | New Task |
+| Tasks | `Esc` | Go back to Projects Pane |
+| Task Detail | `Esc` | Go back to Tasks Pane |
+| Task Detail | `Space` | Toggle task as done/pending |
+| Task Detail | `d` | Set Due date |
+| Task Detail | `↓`/`↑` | Scroll Up/Down the note editor |
+| Task Detail | `e` | Activate note editor for modification |
+| Active Note Editor | `Esc` | Deactivate note editor and save content |
+
+*Tips about using shortcuts efficiently:*  
+
+- `Esc` will bring you a step back - to previous pane in most cases.
+- When you're in Project or Task list, use `↓`/`↑` to navigate the list.
+- When you're in Project or Task list `Enter` will load currently selected Project/Task.
+- After creating new Project, focus will automatically move to Tasks. Start adding tasks immediately by pressing `n`.   
+- After creating new Task, focus will stay in "new task" input. So that you can add tasks quickly one after another. 
+- After creating new Task, Press `Esc` when you're done creating tasks. 
+
+## Building blocks
+
+- Made with :love: and [golang](https://golang.org/) 1.14 *(you don't need golang to run it)*
+- Designed with [tview](https://github.com/rivo/tview) - interactive widgets for terminal-based UI
+- Task Note editor made with [femto](https://github.com/pgavlin/femto)  
+- Datastore is [storm](https://github.com/asdine/storm) - a powerful toolkit for [BoltDB](https://github.com/etcd-io/bbolt)
+
+### Contribute
+
+If you fix a bug or want to add/improve a feature, 
+and it's alligned with the focus (merging with ease) of this tool, 
+I will be glad to accept your PR. :) 
+
+## You may ask...
+
+#### Where is the data stored? Can I change the location?
+
+By default, it will try to create a db file in you home directory. 
+
+But as a geek, you may try to put it different location (e,g, in you dropbox for syncing).
+In that case, just mention `DB_FILE` as an environment variable.
+ 
+```bash
+DB_FILE=~/dropbox/geek-life/default.db geek-life
+```
+
+#### How can I suggest a feature?
+
+Just [post an issue](https://github.com/ajaxray/geek-life/issues/new) describing your desired feature/enhancement 
+and select `feature` label.
+
+Also, incomplete features in the current roadmap will be found in issue list. 
+You may :thumbsup: issues if you want to increase priority of a feature.
+
+---
+### Footnotes 
+1. In my Macbook Air, 1.6 GHz Dual-Core Intel Core i5, RAM: 8 GB 1600 MHz DDR3
+2. Use [monakai](https://github.com/sickill/vim-monokai) color scheme for markdown syntax
+3. Habitica is a free habit and productivity app that treats your real life like a game
+
+---
+> "This is the Book about which there is no doubt, a guidance for those conscious of Allah" - [Al-Quran](http://quran.com)

app/cli.go

@@ -14,21 +14,22 @@ import (
 )
 
 var (
-	app                               *tview.Application
-	newProject, newTask               *tview.InputField
-	projectList, taskList             *tview.List
-	projectPane, taskPane, detailPane *tview.Flex
-	layout, contents                  *tview.Flex
-	statusBar                         *tview.Pages
-	message                           *tview.TextView
-	shortcutsPage, messagePage        string = "shortcuts", "message"
+	app                            *tview.Application
+	newProject, newTask            *tview.InputField
+	projectList, taskList          *tview.List
+	projectPane, projectDetailPane *tview.Flex
+	taskPane, taskDetailPane       *tview.Flex
+	layout, contents               *tview.Flex
+	statusBar                      *tview.Pages
+	message                        *tview.TextView
+	shortcutsPage, messagePage     string = "shortcuts", "message"
 
 	db          *storm.DB
 	projectRepo repository.ProjectRepository
 	taskRepo    repository.TaskRepository
 
 	projects       []model.Project
-	currentProject model.Project
+	currentProject *model.Project
 )
 
 func main() {
@@ -40,36 +41,36 @@ func main() {
 	projectRepo = repo.NewProjectRepository(db)
 	taskRepo = repo.NewTaskRepository(db)
 
-	titleText := tview.NewTextView().SetText("[lime::b]Geek-life [::-]- life management for geeks!").SetDynamicColors(true)
+	titleText := tview.NewTextView().SetText("[lime::b]Geek-life [::-]- Task Manager for geeks!").SetDynamicColors(true)
 	cloudStatus := tview.NewTextView().SetText("[::d]Cloud Sync: off").SetTextAlign(tview.AlignRight).SetDynamicColors(true)
 
 	titleBar := tview.NewFlex().
 		AddItem(titleText, 0, 2, false).
 		AddItem(cloudStatus, 0, 1, false)
 
 	prepareProjectPane()
+	prepareProjectDetail()
 	prepareTaskPane()
 	prepareStatusBar()
 	prepareDetailPane()
 
 	contents = tview.NewFlex().
 		AddItem(projectPane, 25, 1, true).
 		AddItem(taskPane, 0, 2, false)
-		//AddItem(detailPane, 0, 3, true)
 
 	layout = tview.NewFlex().SetDirection(tview.FlexRow).
 		AddItem(titleBar, 2, 1, false).
 		AddItem(contents, 0, 2, true).
 		AddItem(statusBar, 1, 1, false)
 
-	setKeyboardShortcuts(projectPane, taskPane)
+	setKeyboardShortcuts()
 
 	if err := app.SetRoot(layout, true).EnableMouse(true).Run(); err != nil {
 		panic(err)
 	}
 }
 
-func setKeyboardShortcuts(projectPane *tview.Flex, taskPane *tview.Flex) *tview.Application {
+func setKeyboardShortcuts() *tview.Application {
 	return app.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
 		if ignoreKeyEvt() {
 			return event
@@ -81,7 +82,7 @@ func setKeyboardShortcuts(projectPane *tview.Flex, taskPane *tview.Flex) *tview.
 			event = handleProjectPaneShortcuts(event)
 		case taskPane.HasFocus():
 			event = handleTaskPaneShortcuts(event)
-		case detailPane.HasFocus():
+		case taskDetailPane.HasFocus():
 			event = handleDetailPaneShortcuts(event)
 		}
 
@@ -110,9 +111,9 @@ func prepareStatusBar() {
 		tview.NewGrid().
 			SetColumns(0, 0, 0, 0).
 			SetRows(0).
-			AddItem(tview.NewTextView().SetText("Shortcuts: Alt+.(dot)"), 0, 0, 1, 1, 0, 0, false).
-			AddItem(tview.NewTextView().SetText("New Project: n").SetTextAlign(tview.AlignCenter), 0, 1, 1, 1, 0, 0, false).
-			AddItem(tview.NewTextView().SetText("New Task: t").SetTextAlign(tview.AlignCenter), 0, 2, 1, 1, 0, 0, false).
+			AddItem(tview.NewTextView().SetText("Navigate List: ↓/↑"), 0, 0, 1, 1, 0, 0, false).
+			AddItem(tview.NewTextView().SetText("New Task/Project: n").SetTextAlign(tview.AlignCenter), 0, 1, 1, 1, 0, 0, false).
+			AddItem(tview.NewTextView().SetText("Step back: Esc").SetTextAlign(tview.AlignCenter), 0, 2, 1, 1, 0, 0, false).
 			AddItem(tview.NewTextView().SetText("Quit: Ctrl+C").SetTextAlign(tview.AlignRight), 0, 3, 1, 1, 0, 0, false),
 		true,
 		true,

app/project_detail.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/gdamore/tcell"
+	"github.com/rivo/tview"
+)
+
+func prepareProjectDetail() {
+	deleteBtn := makeButton("Delete Project", deleteCurrentProject)
+	clearBtn := makeButton("Clear Completed Tasks", clearCompletedTasks)
+
+	deleteBtn.SetBackgroundColor(tcell.ColorRed)
+	projectDetailPane = tview.NewFlex().SetDirection(tview.FlexRow).
+		// AddItem(activeProjectName, 1, 1, false).
+		// AddItem(makeHorizontalLine(tcell.RuneS3, tcell.ColorGray), 1, 1, false).
+		AddItem(deleteBtn, 3, 1, false).
+		AddItem(blankCell, 1, 1, false).
+		AddItem(clearBtn, 3, 1, false).
+		AddItem(blankCell, 0, 1, false)
+
+	projectDetailPane.SetBorder(true).SetTitle("[::u]A[::-]ctions")
+}
+
+func deleteCurrentProject() {
+	if currentProject != nil && projectRepo.Delete(currentProject) == nil {
+		for i, _ := range tasks {
+			taskRepo.Delete(&tasks[i])
+		}
+
+		showMessage("Removed Project: " + currentProject.Title)
+		removeThirdCol()
+		taskList.Clear()
+		projectList.Clear()
+
+		loadProjectList()
+	}
+}
+
+func clearCompletedTasks() {
+	count := 0
+	for i, task := range tasks {
+		if task.Completed && taskRepo.Delete(&tasks[i]) == nil {
+			taskList.RemoveItem(i)
+			count++
+		}
+	}
+	showMessage(fmt.Sprintf("[yellow]%d tasks cleared!", count))
+}

app/projects.go

@@ -2,24 +2,16 @@ package main
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/asdine/storm/v3"
 	"github.com/gdamore/tcell"
 	"github.com/rivo/tview"
 )
 
 func prepareProjectPane() {
-	var err error
-	projects, err = projectRepo.GetAll()
-	if err != nil {
-		showMessage("Could not load Projects: " + err.Error())
-	}
-
 	projectList = tview.NewList().ShowSecondaryText(false)
-
-	for i := range projects {
-		addProjectToList(i, false)
-	}
+	loadProjectList()
 
 	newProject = makeLightTextInput("+[New Project]").
 		SetDoneFunc(func(key tcell.Key) {
@@ -29,7 +21,7 @@ func prepareProjectPane() {
 				if err != nil {
 					showMessage("[red::]Failed to create Project:" + err.Error())
 				} else {
-					showMessage(fmt.Sprintf("[green::]Project %s created. Press n to start adding new tasks.", newProject.GetText()))
+					showMessage(fmt.Sprintf("[yellow::]Project %s created. Press n to start adding new tasks.", newProject.GetText()))
 					projects = append(projects, project)
 					addProjectToList(len(projects)-1, true)
 					newProject.SetText("")
@@ -46,35 +38,59 @@ func prepareProjectPane() {
 	projectPane.SetBorder(true).SetTitle("[::u]P[::-]rojects")
 }
 
+func loadProjectList() {
+	var err error
+	projects, err = projectRepo.GetAll()
+	if err != nil {
+		showMessage("Could not load Projects: " + err.Error())
+		return
+	}
+
+	projectList.AddItem("[::d]Dynamic Lists", "", 0, nil)
+	projectList.AddItem("[::d]"+strings.Repeat(string(tcell.RuneS3), 25), "", 0, nil)
+	projectList.AddItem("- Today", "", 0, yetToImplement("Today's Tasks"))
+	projectList.AddItem("- Upcoming", "", 0, yetToImplement("Upcoming Tasks"))
+	projectList.AddItem("- No Due Date", "", 0, yetToImplement("Unscheduled Tasks"))
+	projectList.AddItem("", "", 0, nil)
+	projectList.AddItem("[::d]Projects", "", 0, nil)
+	projectList.AddItem("[::d]"+strings.Repeat(string(tcell.RuneS3), 25), "", 0, nil)
+
+	for i := range projects {
+		addProjectToList(i, false)
+	}
+
+	projectList.SetCurrentItem(6) // Select Projects, as dynamic lists are not ready
+}
+
 func addProjectToList(i int, selectItem bool) {
 	// To avoid overriding of loop variables - https://www.calhoun.io/gotchas-and-common-mistakes-with-closures-in-go/
 	projectList.AddItem("- "+projects[i].Title, "", 0, func(idx int) func() {
 		return func() { loadProject(idx) }
 	}(i))
 
 	if selectItem {
-		projectList.SetCurrentItem(i)
+		projectList.SetCurrentItem(projectList.GetItemCount() - 1)
 		loadProject(i)
 	}
 }
 
 func loadProject(idx int) {
-	currentProject = projects[idx]
+	currentProject = &projects[idx]
 	taskList.Clear()
 	app.SetFocus(taskPane)
 	var err error
 
-	if tasks, err = taskRepo.GetAllByProject(currentProject); err != nil && err != storm.ErrNotFound {
+	if tasks, err = taskRepo.GetAllByProject(*currentProject); err != nil && err != storm.ErrNotFound {
 		showMessage("[red::]Error: " + err.Error())
 	}
 
 	for i, task := range tasks {
-		taskList.AddItem(makeTaskListingTitle(task), "", 0, func(taskidx int) func() {
-			return func() { loadTask(taskidx) }
-		}(i))
+		addTaskToList(task, i)
 	}
 
-	contents.RemoveItem(detailPane)
+	removeThirdCol()
+	projectDetailPane.SetTitle("[::b]" + currentProject.Title)
+	contents.AddItem(projectDetailPane, 25, 0, false)
 }
 
 func handleProjectPaneShortcuts(event *tcell.EventKey) *tcell.EventKey {