diff --git a/README.md b/README.md index 384679c..cf3224b 100644 --- a/README.md +++ b/README.md @@ -281,76 +281,5 @@ Checkout the **master branch** to get the sourcecode of the latest released vers Checkout the **develop branch** to take a look at the sourcecode of the incoming release. ## HOW-TO CONTRIBUTE - -### PROJECT STRUCTURE -* `quartz-parent/quartz-manager-starter-api` is the library that can be imported in webapp to have the quartz-manager API. -* `quartz-parent/quartz-manager-starter-ui` is a maven module in charge to build and package the angular frontend in a webjar. -* `quartz-parent/quartz-manager-starter-security` is a library that can be imported in a webapp to have a security layer (login) over the quartz-manager API. -* `quartz-parent/quartz-manager-starter-persistence` is a library that can be imported in a webapp to persist the config and the progress of the trigger a Postgresql database. -* `quartz-parent/quartz-manager-web-showcase` is an example of webapp that imports quartz-manager-api. Useful to develop the frontend started locally with the webpack dev server. -* `quartz-frontend` is the angular app that interacts with the Quartz Manager API. - -### PROJECT DETAILS -**[requirements]** Make sure you have installed -* [Java 9](https://java.com/download/) or greater -* [Maven](https://maven.apache.org/) -* [npm](https://www.npmjs.com/get-npm), [node](https://nodejs.org) and [angular-cli](https://cli.angular.io/) - -To build&run quartz-manager in your machine: - -``` -#CLONE REPOSITORY -git clone https://github.com/fabioformosa/quartz-manager.git - -# START QUARTZ-MANAGER-WEB -cd quartz-manager/quartz-parent -mvn install -cd quartz-manager/quartz-parent/quartz-manager-web-showcase -mvn spring-boot:run - -# START QUARTZ-MANAGER-FRONTEND -cd quartz-manager/quartz-manager-frontend -npm install -npm start - -``` - -1. Open browser at [http://localhost:4200](http://localhost:4200) -1. Log in with **default credentials**: `admin/admin` - -If you are not confident with maven CLI, you can start it by your IDE. For more details [spring boot ref.](http://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-running-your-application.html) - - -## HOW TO RUN YOUR SCHEDULED JOB -By default, `quartz-manager-web-showcase` executes the dummy job that logs "hello world!". -Replace the dummy job (class: `it.fabioformosa.quartzmanager.jobs.SampleJob`) with yours. Follow these steps: - -1. Extend the super class `it.fabioformosa.quartzmanager.jobs.AbstractLoggingJob` -1. set property `quartz-manager.jobClass` with qualified name of your custom Job Class (default job is SampleJob.class) - -## HOW TO CHANGE SETTINGS -* Num of Threads: `/quartz-manager-parent/quartz-manager-web/src/main/resources/quartz.properties` -* Credentials: To change admin's password, set ENV var `quartz-manager.account.pwd` -* quartz-manager backend context path (default `/quartz-manager`) and port (default `8080`): `/quartz-manager/src/main/resources/application.properties` - -## Tech Overview - -**Backend Stack** Java 9, Spring Boot 2.5.6 (Spring MVC 5.3.12, Spring Security 5.5.3), Quartz Scheduler 2.3.2 - -**Application Server** Tomcat (embedded) - -**Frontend** Angular 9.1.4, Web-Socket (stompjs 2.3.3) - -**Style** Angular Material 9, FontAwesome 5 - -Starting from Quartz Manager v2.x.x, the new structure of project is: - * REST API backend - * Single Page Application frontend (angular 9) - -(The first version of quartz manager was a monolithic backend that provided also frontend developed with angularjs 1.6.x. You can find it at the branch 1.x.x) - -## Contributes - -Every contribution is welcome. Open a issue, so we can discuss about new features and implement them. - +For tech details, how-to run locally the project and how-to contribute, reach out this other [README](https://github.com/fabioformosa/quartz-manager/blob/develop/quartz-manager-parent/README.md)