updates to readme and screenshots

This commit is contained in:
Suraj Patil 2016-08-30 21:24:35 +05:30
parent cf1edf72e8
commit d6b52be000
4 changed files with 18 additions and 9 deletions

View File

@ -4,6 +4,11 @@ Tasks is a simplistic Go webapp to manage tasks, I built this tool to manage tas
How to use? How to use?
================== ==================
Via script: `bash install.sh`
This will generate the binary and set up the database. If you want, you can copy the binary and the public folder into a folder of your choice.
Manually:
1. `go get github.com/thewhitetulip/Tasks` 1. `go get github.com/thewhitetulip/Tasks`
1. change dir to the respective folder and create the db file: `cat schema.sql | sqlite3 tasks.db` 1. change dir to the respective folder and create the db file: `cat schema.sql | sqlite3 tasks.db`
@ -11,32 +16,36 @@ How to use?
1. `./Tasks` 1. `./Tasks`
1. open [localhost:8081](http://localhost:8081) 1. open [localhost:8081](http://localhost:8081)
You can change the port in the [config] (https://github.com/thewhitetulip/Tasks/blob/master/config.json) file You can change the port in the [config](https://github.com/thewhitetulip/Tasks/blob/master/config.json) file
##Features ##Features
1. Add, update, delete task 1. Add, update, delete task.
2. Search tasks, the query is highlighted in the search results page 2. Search tasks, the query is highlighted in the search results page.
3. We use github flavoured markdown, which enables us for using a task list, advanced syntax highlighting and much more 3. Github flavoured markdown, which enables us for using a task list, advanced syntax highlighting and much more.
4. Supports file upload, randomizes the file name, stores the user given filename in a db and works on the randomized file name for security reasons. 4. Supports file upload, randomizes the file name, stores the user given filename in a db and works on the randomized file name for security reasons.
5. Priorities are assigned, High = 3, medium = 2 and low = 1, sorting is done on priority descending and created date ascending 5. Priorities are assigned, High = 3, medium = 2 and low = 1, sorting is done on priority descending and created date ascending.
6. Categories are supported, you can add tasks to different categories. 6. Categories are supported, you can add tasks to different categories.
1. Ability to hide a task from the timeline.
1. For a task list, shows 6 out of 8 tasks completed.
1. Single click install, just run the install.sh file.
##### Book ##### Book
I am learning writing webapps with Go as I build this application, I took to writing an introductory book about [building webapps in Go] (https://github.com/thewhitetulip/web-dev-golang-anti-textbook) because I faced a lot of problems while learning how to write webapps in Go, it, the book strives to teach by practical examples. You are welcome to contribute to the book. I am learning writing webapps with Go as I build this application, I took to writing an introductory book about [building webapps in Go](https://github.com/thewhitetulip/web-dev-golang-anti-textbook) because I faced a lot of problems while learning how to write webapps in Go, it, the book strives to teach by practical examples. You are welcome to contribute to the book.
#Screenshots #Screenshots
The Home Page The Home Page
![Home Page] (https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd.png) ![Home Page](https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd.png)
Add Task dialog Add Task dialog
![Add Task] (https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd-Add%20task.png) ![Add Task](https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd-Add%20task.png)
Navigation drawer Navigation drawer
![Navigation Drawer] (https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd%20Navigation%20Drawer.png) ![Navigation Drawer](https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd%20Navigation%20Drawer.png)
#License #License

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 85 KiB