Skip to content

Commit 82a0c0d

Browse files
thomaswoehlkethomaswoehlke
committed
Updated Documentation
1 parent 979fb94 commit 82a0c0d

File tree

14 files changed

+992
-881
lines changed

14 files changed

+992
-881
lines changed

‎README.md‎

Lines changed: 23 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,39 @@
1-
simpleworklist
2-
==============
1+
# simpleworklist
32

4-
Your Todo List for Getting Things Done
3+
![Java CI with Maven](https://github.com/Spring-Framework-Java-Apps/simpleworklist/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master)
54

6-
Software-Stack: Spring-Boot, JPA, Spring MVC, Thymeleaf, Twitter Bootstrap, jQuery, HTML5
75

8-
Status
9-
------
10-
![Java CI with Maven](https://github.com/Spring-Framework-Java-Apps/simpleworklist/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master)
6+
Your Todo List for Getting Things Done
117

12-
Getting Things Done
13-
-------------------
8+
## Getting Things Done
149
GTD® and Getting Things Done® are registered trademarks of the David Allen Company.
1510
SimpleWorklist is not affiliated with or endorsed by the David Allen Company.
1611

17-
Developer Reminder
18-
------------------
19-
* Create serialVersionUID for Classes with "implements Serializable": use the JDK tool “serialver“
20-
21-
22-
Drag and Drop
23-
-------------
24-
* https://jqueryhouse.com/jquery-drag-and-drop-plugins/
25-
* https://mdbootstrap.com/plugins/jquery/draggable/#introduction
26-
* https://github.com/Shopify/draggable/tree/master/examples/src/content/Droppable/UniqueDropzone
27-
* https://github.com/Shopify/draggable#documentation
28-
* https://jqueryhouse.com/jquery-drag-and-drop-plugins/
29-
* https://shopify.github.io/draggable/examples/simple-list.html
30-
* https://www.elated.com/drag-and-drop-with-jquery-your-essential-guide/
31-
* https://medium.com/@okandavut/using-jquery-ui-drag-drop-64a24e75e805
32-
33-
Shortcuts
34-
---------
35-
* https://fontawesome.com/icons?d=gallery&m=free
36-
* https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html
37-
* https://ckeditor.com/docs/ckeditor4/latest/guide/dev_installation.html
38-
* http://impossibl.github.io/pgjdbc-ng/docs/current/user-guide/#drivers
39-
* https://devcenter.heroku.com/articles/getting-started-with-java
40-
* https://devcenter.heroku.com/articles/java-support#specifying-a-java-version
41-
42-
# java-getting-started
43-
44-
A barebones Java app, which can easily be deployed to Heroku.
45-
46-
This application supports the [Getting Started with Java on Heroku](https://devcenter.heroku.com/articles/getting-started-with-java) article - check it out.
12+
## Live
13+
A Java Web App, which can easily be deployed to Heroku.
4714

4815
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
4916

50-
## Running Locally
51-
52-
Make sure you have Java and Maven installed. Also, install the [Heroku CLI](https://cli.heroku.com/).
53-
54-
```sh
55-
$ git clone https://github.com/heroku/java-getting-started.git
56-
$ cd java-getting-started
57-
$ mvn install
58-
$ heroku local:start
59-
```
60-
61-
Your app should now be running on [localhost:5000](http://localhost:5000/).
62-
63-
If you're going to use a database, ensure you have a local `.env` file that reads something like this:
17+
## Development
6418

65-
```
66-
JDBC_DATABASE_URL=jdbc:postgresql://localhost:5432/java_database_name
67-
```
19+
* Info: http://spring-framework-java-apps.github.io/simpleworklist/
20+
* For Developers: http://localhost:5000/
6821

69-
## Deploying to Heroku
22+
### Github Shortcuts
23+
* [Projects](https://github.com/Spring-Framework-Java-Apps/simpleworklist/projects)
24+
* [Milestones](https://github.com/Spring-Framework-Java-Apps/simpleworklist/milestones)
25+
* [Issues](https://github.com/Spring-Framework-Java-Apps/simpleworklist/issues)
26+
* [Releases](https://github.com/Spring-Framework-Java-Apps/simpleworklist/releases)
27+
* [Branches](https://github.com/Spring-Framework-Java-Apps/simpleworklist/branches)
28+
* [CI](https://github.com/Spring-Framework-Java-Apps/simpleworklist/actions)
7029

71-
```sh
72-
$ heroku create
73-
$ git push heroku master
74-
$ heroku open
75-
```
30+
## Requirements
7631

77-
## Documentation
32+
### Functional Requirements
33+
[Functional Requirements](etc/requirements/requirements.md)
7834

79-
For more information about using Java on Heroku, see these Dev Center articles:
35+
### Nonfunctional Requirements
36+
[Nonfunctional Requirements]()
8037

81-
- [Java on Heroku](https://devcenter.heroku.com/categories/java)
38+
## Development
39+
* [Changelog](etc/Changelog.md)

‎etc/Changelog.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Changelog
2+

‎etc/HOWTO.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
Howto Reminder
2+
3+
## github
4+
* [Issues](https://github.com/BloodMoneyApp/bloodmoney/issues)
5+
* [Projects](https://github.com/BloodMoneyApp/bloodmoney/projects)
6+
* [Milestones](https://github.com/BloodMoneyApp/bloodmoney/milestones)
7+
* [Releases](https://github.com/BloodMoneyApp/bloodmoney/releases)
8+
9+
## Development
10+
* [Changelog](etc/RELEASES.md)
11+
* [Todo](etc/TODO.md)
12+
* [Howto](etc/HOWTO.md)
13+
14+
15+
## 3rd Party Software
16+
### Howto
17+
* [Spring dependency-management-plugin](https://docs.spring.io/dependency-management-plugin/docs/current/reference/html/)
18+
* [Example on github: heroku and Gradle](https://github.com/heroku/gradle-getting-started/blob/master/build.gradle)
19+
* [Howto: Using lombok](https://projectlombok.org/setup/overview)
20+
* [Howto: Gradle Docker Compose](https://bmuschko.com/blog/gradle-docker-compose/)
21+
22+
### Documentation
23+
* [spring-boot](https://spring.io/projects/spring-boot)
24+
* [spring-data-jpa](https://spring.io/projects/spring-data-jpa)
25+
* [spring-framework](https://spring.io/projects/spring-framework)
26+
* [spring-framework Data Access](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/data-access.html)
27+
* [spring-framework WebMVC](https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html)
28+
* [spring-boot reference](https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/html/)
29+
* [spring-boot appendix-application-properties](https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/html/appendix-application-properties.html#common-application-properties)
30+
* [spring-boot api](https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/api/)
31+
* [spring-data-jpa](https://docs.spring.io/spring-data/jpa/docs/2.2.5.RELEASE/reference/html/#reference)
32+
33+
### Gradle Plugins
34+
* [org.springframework.boot](https://plugins.gradle.org/plugin/org.springframework.boot)
35+
* [org.springframework.cloud.contract](https://plugins.gradle.org/plugin/org.springframework.cloud.contract)
36+
* [io.spring.dependency-management](https://plugins.gradle.org/plugin/io.spring.dependency-management)
37+
* [org.asciidoctor.jvm.convert](https://plugins.gradle.org/plugin/org.asciidoctor.jvm.convert)
38+
* [com.avast.gradle.docker-compose](https://plugins.gradle.org/plugin/com.avast.gradle.docker-compose)
39+
* [org.liquibase.gradle](https://plugins.gradle.org/plugin/org.liquibase.gradle)
40+
41+
### Github Repos
42+
* [spring-cloud-contract](https://github.com/spring-cloud/spring-cloud-contract)
43+
* [dependency-management-plugin](https://github.com/spring-gradle-plugins/dependency-management-plugin)
44+
* [asciidoctor-gradle-plugin](https://github.com/asciidoctor/asciidoctor-gradle-plugin)
45+
* [gradle-docker-compose-plugin](https://github.com/avast/gradle-docker-compose-plugin)
46+
* [liquibase-gradle-plugin](https://github.com/liquibase/liquibase-gradle-plugin)
47+
48+
## Database and JPA
49+
### DB Datatypes
50+
* [H2 Datatypes](http://www.h2database.com/html/datatypes.html)
51+
* [PostgreSQL Datatypes](https://www.postgresql.org/docs/11/datatype.html)
52+
* LocalDateTime and TimeZone: TODO
53+
54+
### UUID and Optimistic Locking
55+
* UUID: TODO
56+
57+
### Database Schema Evolution with Spring Boot JPA
58+
* TODO
59+
* org.flywaydb:flyway
60+
* org.liquibase:liquibase https://www.liquibase.org/documentation/maven/index.html
61+
62+
63+
## Frontend with webjars
64+
65+
### updating webjar Versions:
66+
* change Version in build.gradle "ext" (Line 40)
67+
* change Version in src/main/resources/templates/layout/page.html Section head.tw-head and div.tw-footer (Lines 16, 98)

‎etc/development/Development.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Development
2+
3+
## Developer Reminder
4+
* Create serialVersionUID for Classes with "implements Serializable": use the JDK tool “serialver“
5+
6+
## Frontend
7+
8+
### Drag and Drop
9+
* [jquery-drag-and-drop-plugins](https://jqueryhouse.com/jquery-drag-and-drop-plugins/)
10+
* [jquery draggable](https://mdbootstrap.com/plugins/jquery/draggable/#introduction)
11+
* [shopify draggable: UniqueDropzone](https://github.com/Shopify/draggable/tree/master/examples/src/content/Droppable/UniqueDropzone)
12+
* [shopify draggable: documentation](https://github.com/Shopify/draggable#documentation)
13+
* [shopify draggable: example](https://shopify.github.io/draggable/examples/simple-list.html)
14+
* [drag-and-drop-with-jquery-your-essential-guide](https://www.elated.com/drag-and-drop-with-jquery-your-essential-guide/)
15+
* [using-jquery-ui-drag-drop](https://medium.com/@okandavut/using-jquery-ui-drag-drop-64a24e75e805)
16+
17+
### Shortcuts
18+
* [fontawesome](https://fontawesome.com/icons?d=gallery&m=free)
19+
* [ckeditor](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_installation.html)
20+
21+
### Templates
22+
* [thymeleaf](https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html)
23+
24+
## Backend
25+
* [Alternative PostgreSQL JDBC 4.2* Driver](http://impossibl.github.io/pgjdbc-ng/docs/current/user-guide/#drivers)
26+
27+
## Heroku
28+
### java
29+
* [heroku: getting-started-with-java](https://devcenter.heroku.com/articles/getting-started-with-java)
30+
* [heroku: java-support java-version](https://devcenter.heroku.com/articles/java-support#specifying-a-java-version)
31+
32+
### Running Locally
33+
TBD:
34+
Make sure you have Java and Maven installed. Also, install the [Heroku CLI](https://cli.heroku.com/).
35+
36+
```sh
37+
$ git clone https://github.com/heroku/java-getting-started.git
38+
$ cd java-getting-started
39+
$ mvn install
40+
$ heroku local:start
41+
```
42+
43+
Your app should now be running on [localhost:5000](http://localhost:5000/).
44+
45+
If you're going to use a database, ensure you have a local `.env` file that reads something like this:
46+
47+
```
48+
JDBC_DATABASE_URL=jdbc:postgresql://localhost:5432/java_database_name
49+
```
50+
51+
#### Deploying to Heroku
52+
53+
```sh
54+
$ heroku create
55+
$ git push heroku master
56+
$ heroku open
57+
```
58+
59+
#### Documentation
60+
For more information about using Java on Heroku, see these Dev Center articles:
61+
* [Java on Heroku](https://devcenter.heroku.com/categories/java)

0 commit comments

Comments
 (0)