Reading tips is a web app that at its core lets the user save down reading tips of different types. Other features include tagging, filtering and prioritizing tips, adding comments and keeping track of what you've already read.
A (modernish) browser running JavaScript is required for this app to work properly.
To run the app locally:
- Clone this repository
- Install gradle
- Run
gradle runin the project folder. A local server will be created tolocalhost:8080
The app should be quite intuitive to use. At the bottom of the page you will find a form to create a new reading tip. Currently you can choose from three types of reading tips. You can filter the reading tips from the top right hand of the screen. Click a comment section to browse and possibly leave a comment on a reading tip. You can reorder reading tips by dragging and dropping them around, however already read reading tips will always be found at the bottom of the page. It is only possible to reorder tips that belong to the same category (either read, or unread).
- Heroku
- Test coverage report
- Architecture
- Product Backlog
- Sprint 1 Backlog
- Sprint 2 Backlog
- Sprint 3 Backlog
- Sprint 4 Backlog
- Project report
- License
A user story can be seen as done when all of the following requirements are fulfilled:
- The acceptance criteria of the user story are fulfilled
- All tests pass successfully
- The line coverage for all tests is at least 80%
- The code is documented at a general level (The usage cases for classes)
- Travis CI build is successful
- Heroku build is successful and runs