Plume showcase

This project enables to test quickly the Plume Framework ecosystem. It contains:

• An embedded database
• An integration with Plume Admin

A React administration frontend using this showcase project can be setup quickly with Create Plume React Project.

Configuring your IDE

Install Lombok: http://jnb.ociweb.com/jnb/jnbJan2010.html#installation

Launching the server

Just run the com.coreoz.WebApplication class, you can then open your browser to http://localhost:8080.

Configuration

The configuration file is located in src/main/resources/application.conf. If you have any doubt, check out the configuration documentation.

Administration area

The React frontend can be started using yarn start and opening http://localhost:3000/.

In the login screen, the credentials are:

• login: admin
• password: admin

Swagger

Swagger is pre-configured to provide documentation about the project web-services. This documentation is protected by credentials that should be configured in the application.conf file.

To access this documentation, start the project and go to http://localhost:8080/. As a reminder, the default Swagger credentials are: plume//rocks.

Monitoring

Application monitoring is available through the API:

• http://localhost:8080/monitoring/info
• http://localhost:8080/monitoring/health
• http://localhost:8080/monitoring/metrics

There is a basic authentication for security, the credentials are: plume//rocks.

File

Plume File is available through the library API:

• http://localhost:8080/files/{file-unique-nama}

2 files upload endpoints examples were added in FileUploadWs:

• http://localhost:8080/files/pictures that only accepts png files
• http://localhost:8080/files/reports that only accept Excel files

Database

To generate classes corresponding to the database tables, you can run the com.coreoz.db.QuerydslGenerator.main() method. On Intellij the Maven querydsl-code-generation profile must be used for that, so these steps must be followed in Intellij:

1. Click on the Maven pane on the right
2. In the Profiles block, select the querydsl-code-generation profile
3. Update the Maven project
4. Run the com.coreoz.db.QuerydslGenerator.main() method

See the detailed documentations:

• Plume Database
• Plume Querydsl
• Plume Querydsl codegen

Documentation about initial database configuration is available in the Plume Maven Archetype.