From fae060e0395035d290fefad7a68f59332a1a0a52 Mon Sep 17 00:00:00 2001 From: Alex Tusa <41128169+atusa17@users.noreply.github.com> Date: Mon, 4 Mar 2019 17:57:37 -0700 Subject: [PATCH 1/7] Update README.md --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc1251a..34d5ce3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ # Pandamonium Theorem Prover -This is the main repository for the Technical Software Project +This project contains several different modules for different parts of the system. + +* [psersistence](persistence/README.md) +* [web-server](src/README.md) + +## Getting Started + +1. Clone the project. `git clone git@github.com:atusa17/tsp.git` +2. Open the `pandamonium-theorem-prover` folder with IntelliJ. Use auto-import for a Gradle project. +3. Individual Components have their own README. Continue there. + +## Running the Tests + +This project is unit tested with JUnit and Mockito. You can run the unit tests with IntelliJ or Gradle. To run them with IntelliJ, browse to any `*Test.java` file and use IntelliJ's built-in test runner to run or debug the test. To run all the unit tests with Gradle: + +* On a Linux or Macintosh machine: + $ ./gradlew test +* On a Windows machine: + $ gradlew.bat test + +You can also test modules individually: + +* On a Linux or Macintosh machine: + + $ ./gradlew persistence:test + +* On a Windows machine: + + $ gradlew.bat persistence:test + +## Integration Tests + +To run the integration tests with IntelliJ, browse to any `*Test.java` file residing in any module name `integrationTest` and use IntelliJ's built-in test runner to run or debug the test. To run all the integration tests with Gradle: + +* On a Linux or Macintosh machine: + + $ ./gradlew integrationTest + +* On a Windows machine + + $ gradlew.bat integrationTest + +## Built with + +* [Spring Boot](https://projects.spring.io/spring-boot/) - Web framework +* [Spring Web Flow](https://projects.spring.io/spring-webflow/) - MVC framework +* [Gradle](https://gradle.org/) - Dependency management +* [JUnit](http://junit.org/junit4/) - Unit tests +* [Mockito](http://site.mockito.org/) - Mock objects library From b154648fdfb759a334c27f321a206e93adb94e99 Mon Sep 17 00:00:00 2001 From: Alex Tusa <41128169+atusa17@users.noreply.github.com> Date: Mon, 4 Mar 2019 17:59:00 -0700 Subject: [PATCH 2/7] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 34d5ce3..43c138b 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,19 @@ This project contains several different modules for different parts of the syste This project is unit tested with JUnit and Mockito. You can run the unit tests with IntelliJ or Gradle. To run them with IntelliJ, browse to any `*Test.java` file and use IntelliJ's built-in test runner to run or debug the test. To run all the unit tests with Gradle: * On a Linux or Macintosh machine: - $ ./gradlew test + $ ./gradlew test * On a Windows machine: - $ gradlew.bat test + $ gradlew.bat test You can also test modules individually: * On a Linux or Macintosh machine: - $ ./gradlew persistence:test + $ ./gradlew persistence:test * On a Windows machine: - $ gradlew.bat persistence:test + $ gradlew.bat persistence:test ## Integration Tests @@ -35,11 +35,11 @@ To run the integration tests with IntelliJ, browse to any `*Test.java` file resi * On a Linux or Macintosh machine: - $ ./gradlew integrationTest + $ ./gradlew integrationTest * On a Windows machine - $ gradlew.bat integrationTest + $ gradlew.bat integrationTest ## Built with From 953f8d807cb25965204ecbd698e9692ff4f299d1 Mon Sep 17 00:00:00 2001 From: Alex Tusa <41128169+atusa17@users.noreply.github.com> Date: Mon, 4 Mar 2019 18:01:24 -0700 Subject: [PATCH 3/7] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 43c138b..9141861 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,22 @@ This project contains several different modules for different parts of the syste This project is unit tested with JUnit and Mockito. You can run the unit tests with IntelliJ or Gradle. To run them with IntelliJ, browse to any `*Test.java` file and use IntelliJ's built-in test runner to run or debug the test. To run all the unit tests with Gradle: * On a Linux or Macintosh machine: - $ ./gradlew test + + ```$ ./gradlew test``` + * On a Windows machine: - $ gradlew.bat test + + ```$ gradlew.bat test``` You can also test modules individually: * On a Linux or Macintosh machine: - $ ./gradlew persistence:test + ```$ ./gradlew persistence:test``` * On a Windows machine: - $ gradlew.bat persistence:test + ```$ gradlew.bat persistence:test``` ## Integration Tests @@ -35,11 +38,11 @@ To run the integration tests with IntelliJ, browse to any `*Test.java` file resi * On a Linux or Macintosh machine: - $ ./gradlew integrationTest + ```$ ./gradlew integrationTest``` * On a Windows machine - $ gradlew.bat integrationTest + ```$ gradlew.bat integrationTest``` ## Built with From f2498f4bda3180785bb772d5ce35a8331f0927e8 Mon Sep 17 00:00:00 2001 From: Alex Tusa <41128169+atusa17@users.noreply.github.com> Date: Mon, 4 Mar 2019 18:01:52 -0700 Subject: [PATCH 4/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9141861..aa68281 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Pandamonium Theorem Prover This project contains several different modules for different parts of the system. -* [psersistence](persistence/README.md) +* [persistence](persistence/README.md) * [web-server](src/README.md) ## Getting Started From 0b6e18b795b6c6af22eab9b67340c3d8b9b83d24 Mon Sep 17 00:00:00 2001 From: Alex Tusa <41128169+atusa17@users.noreply.github.com> Date: Mon, 4 Mar 2019 18:12:33 -0700 Subject: [PATCH 5/7] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index aa68281..1f5edb6 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,4 @@ To run the integration tests with IntelliJ, browse to any `*Test.java` file resi * [Gradle](https://gradle.org/) - Dependency management * [JUnit](http://junit.org/junit4/) - Unit tests * [Mockito](http://site.mockito.org/) - Mock objects library +* [Lombok](https://projectlombok.org/) - Boilerplate Code Generator From 0167ac1a11e4b1aeb5efd79f137289dfde3daf11 Mon Sep 17 00:00:00 2001 From: Alex Tusa <41128169+atusa17@users.noreply.github.com> Date: Mon, 4 Mar 2019 18:13:36 -0700 Subject: [PATCH 6/7] Create README.md --- persistence/README.md | 61 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 persistence/README.md diff --git a/persistence/README.md b/persistence/README.md new file mode 100644 index 0000000..4258ce9 --- /dev/null +++ b/persistence/README.md @@ -0,0 +1,61 @@ +## PTP Persistence API + +The PTP Persistence API is the web API for accessing the theorems database. + + + +## Running from IntelliJ + +* Create a new run configuration in IntelliJ. + + ``` + Name: "PTP Persistence API Tomcat" + Application Server: Tomcat (8.5.12) + HTTP Port: 8090 + JMX Port: 1090 + Deployment tabe: Deploy persistence-api.war (exploded) + ``` +## Running the Tests + +This project is unit tested with JUnit and Mockito. You can run the unit tests with IntelliJ or Gradle. To run them with IntelliJ, browse to any `*Test.java` file and use IntelliJ's built-in test runner to run or debug the test. To run all the unit tests with Gradle: + +* On a Linux or Macintosh machine: + + ```$ ./gradlew test``` + +* On a Windows machine: + + ```$ gradlew.bat test``` + +You can also test modules individually: + +* On a Linux or Macintosh machine: + + ```$ ./gradlew persistence:test``` + +* On a Windows machine: + + ```$ gradlew.bat persistence:test``` + +## Integration Tests + +To run the integration tests with IntelliJ, browse to any `*Test.java` file residing in any module name `integrationTest` and use IntelliJ's built-in test runner to run or debug the test. To run all the integration tests with Gradle: + +* On a Linux or Macintosh machine: + + ```$ ./gradlew integrationTest``` + +* On a Windows machine + + ```$ gradlew.bat integrationTest``` + +## Built with + +* [Spring Boot](https://projects.spring.io/spring-boot/) - Web framework +* [Spring Web Flow](https://projects.spring.io/spring-webflow/) - MVC framework +* [Spring Data](https://spring.io/projects/spring-data/) - Persistence framework +* [Gradle](https://gradle.org/) - Dependency management +* [JUnit](http://junit.org/junit4/) - Unit tests +* [Mockito](http://site.mockito.org/) - Mock objects library +* [Lombok](https://projectlombok.org/) - Boilerplate Code Generator +* [Hibernate ORM](http://hibernate.org/orm/) - Object/Relational Mapping From 27e56039f48c0b1d4f396693e6e34ebfa6710abc Mon Sep 17 00:00:00 2001 From: Alex Tusa <41128169+atusa17@users.noreply.github.com> Date: Mon, 4 Mar 2019 18:15:22 -0700 Subject: [PATCH 7/7] Create README.md --- src/README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 src/README.md diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..6ee4af6 --- /dev/null +++ b/src/README.md @@ -0,0 +1,58 @@ +## PTP Persistence API + +The PTP Persistence API is the web API for accessing the theorems database. + + + +## Running from IntelliJ + +* Create a new run configuration in IntelliJ. + + ``` + Name: "Pandamonium Theorem Prover Tomcat" + Application Server: Tomcat (8.5.12) + HTTP Port: 8080 + JMX Port: 1080 + Deployment tabe: Deploy pandamonium-theorem-prover.war (exploded) + ``` +## Running the Tests + +This project is unit tested with JUnit and Mockito. You can run the unit tests with IntelliJ or Gradle. To run them with IntelliJ, browse to any `*Test.java` file and use IntelliJ's built-in test runner to run or debug the test. To run all the unit tests with Gradle: + +* On a Linux or Macintosh machine: + + ```$ ./gradlew test``` + +* On a Windows machine: + + ```$ gradlew.bat test``` + +You can also test modules individually: + +* On a Linux or Macintosh machine: + + ```$ ./gradlew persistence:test``` + +* On a Windows machine: + + ```$ gradlew.bat persistence:test``` + +## Integration Tests + +To run the integration tests with IntelliJ, browse to any `*Test.java` file residing in any module name `integrationTest` and use IntelliJ's built-in test runner to run or debug the test. To run all the integration tests with Gradle: + +* On a Linux or Macintosh machine: + + ```$ ./gradlew integrationTest``` + +* On a Windows machine + + ```$ gradlew.bat integrationTest``` + +## Built with + +* [Spring Boot](https://projects.spring.io/spring-boot/) - Web framework +* [Gradle](https://gradle.org/) - Dependency management +* [JUnit](http://junit.org/junit4/) - Unit tests +* [Mockito](http://site.mockito.org/) - Mock objects library +* [Lombok](https://projectlombok.org/) - Boilerplate Code Generator