github/quartz-manager
1
0
Fork 0
mirror of https://github.com/fabioformosa/quartz-manager.git synced 2026-05-14 22:00:30 +09:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Fabio Formosa
2021-02-02 23:55:05 +01:00
committed by GitHub
parent 56c81caf05
commit a7a86f960a
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -16,11 +16,20 @@ Through this webapp you can launch and control your scheduled job. The UI Consol
Open the [Project Roadmap](https://github.com/fabioformosa/quartz-manager/projects) to take a look at the plan of Quartz Manager. Open the [Project Roadmap](https://github.com/fabioformosa/quartz-manager/projects) to take a look at the plan of Quartz Manager.
Currently this project might be useful to look how to import Quartz Library in a spring boot application. For this purpose, browse the folder `quartz-manager-parent/quartz-manager-api`. Currently this project might be useful to look how to import Quartz Library in a spring boot application. For this purpose, browse the folder `quartz-manager-parent/quartz-manager-api`.
We're just working to create a library, from project `quartz-manager-parent/quartz-manager-api`, to be imported in your spring boot where you have your job to be scheduled. We're just working to create a library, from project `quartz-manager-parent/quartz-manager-api`, to be imported in your spring boot where you have your job to be scheduled.
The project `quartz-manager-parent/quartz-manager-web` is an example of how-to: The project [Quartz-Manager Demo](https://github.com/fabioformosa/quartz-manager-demo) is an example of how-to:
* import the library * import the quartz-manager-api library
* include the quartz-manager frontend (angular based) through a webjar
* set the application.yml * set the application.yml
* add secure layer * add secure layer to allow the API only to logged users
* schedule a custom job (a dummy `hello world`) * schedule a custom job (a dummy `hello world`)
**NB**: In few days, we'll release the library jar of quartz-manager into the maven central repo.
Next steps in the roadmap are:
* to add a persistent layer to save all job setup.
* to add a complete setup UI panel for quartz, in term of cronjobs and multiple jobs.
* to add CI/CD pipeline to ease the deploy pulling a docker container.
* Enabling adapters for integrations: kafka, etc.
## PROJECT STRUCTURE ## PROJECT STRUCTURE
* **quartz-parent/quartz-manager-api** is the library that can be imported in webapp to have the quartz-manager API. * **quartz-parent/quartz-manager-api** is the library that can be imported in webapp to have the quartz-manager API.
@@ -29,14 +38,7 @@ The project `quartz-manager-parent/quartz-manager-web` is an example of how-to:
* **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-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. * **quartz-frontend** is the angular app that interacts with the Quartz Manager API.
Next steps in the roadmap are: ## HOW-TO CONTRIBUTE
* to add a persistent layer to save all job setup.
* to add a complete setup UI panel for quartz, in term of cronjobs and multiple jobs.
* to add CI/CD pipeline to ease the deploy pulling a docker container.
* Enabling adapters for integrations: kafka, etc.
## QUICK START
**[requirements]** Make sure you have installed **[requirements]** Make sure you have installed
* [Java 8](https://java.com/download/) or greater * [Java 8](https://java.com/download/) or greater
* [Maven](https://maven.apache.org/) * [Maven](https://maven.apache.org/)