reivilibre/TaskBoard
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 2 Wiki Activity

Re-order sections, Add Contributing section

Browse Source
This commit is contained in:
kiswa 2016-04-21 14:23:48 +00:00
parent 68051cdf8a
commit 4818f73680
1 changed files with 22 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -20,7 +20,7 @@ If you're comfortable changing code, you can use any database [supported by RedB
Installing TaskBoard is as easy as 1, 2, 3!
1. Download the latest release (or whatever version you want)
1. Download [the latest release](#) (or whatever version you want)
2. Extract it to your webserver
3. Verify the `api` directory is writable
@ -32,21 +32,6 @@ Developing on TaskBoard is pretty simple too.
2. Run `npm i` to install dependencies (Linting the SCSS requires Ruby and running `gem install scss-lint`)
3. Run `git checkout dev` to work on the `dev` branch
### How It's Made
1. Front end
* [Angular 2](https://angular.io/) single-page app
* [Bourbon](http://bourbon.io/) and [Neat](http://neat.bourbon.io/) SCSS library & framework
* [marked](https://github.com/chjj/marked) Markdown parser
2. Back end
* [Slim Framework](http://www.slimframework.com/) and [RedBeanPHP](http://www.redbeanphp.com/) for a RESTful API
* [PHPMailer](https://github.com/PHPMailer/PHPMailer) for sending emails.
* [JWT](https://jwt.io/) authentication
* [SQLite](https://www.sqlite.org/) database
## Features
### Boards
@ -78,6 +63,27 @@ TaskBoard uses a [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdow
Once an item has been entered, it may have Comments or Attachments added to it by viewing the task detail. There is a link to edit the item, which takes you to a modal much like the original add item dialog. For admin users, there is also a link to delete the item. This view also shows the task's activity log on the right side of the screen, displaying the complete history of events related to the item.
## How It's Made
1. Front end
* [Angular 2](https://angular.io/) single-page app
* [Bourbon](http://bourbon.io/) and [Neat](http://neat.bourbon.io/) SCSS library & framework
* [marked](https://github.com/chjj/marked) Markdown parser
2. Back end
* [Slim Framework](http://www.slimframework.com/) and [RedBeanPHP](http://www.redbeanphp.com/) for a RESTful API
* [PHPMailer](https://github.com/PHPMailer/PHPMailer) for sending emails.
* [JWT](https://jwt.io/) authentication
* [SQLite](https://www.sqlite.org/) database
## Contributing
Fork the repository and make your changes on the `dev` branch.
Create a pull request against the `dev` branch to merge your changes with the main repository.
## Feedback
Constructive feedback is appreciated! If you have ideas for improvement, please [add an issue](https://github.com/kiswa/TaskBoard/issues) or implement it and submit a pull request.