diff --git a/README.md b/README.md new file mode 100644 index 0000000..12f6e19 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# perftests-springboot + +This is a test for Spring Boot to handle large projets, in quantity of objects to manage. + +To use this project, you have to generate the _actual_ code: + +1. Set the root path in `src/main/java/fr/spacefox/perftests/springboot/generator/Generator.java` constant `ROOT_PATH` + to the _actual_ path of your project sources. +2. You may change the number of elements to generate with `ELEMENTS` in the same file. +3. Run the Generator: now you have a giant Spring Boot project ready to be used! +4. Build and play! **Caution:** tests will relaunch the PostgreSQL stack on **each** test therefore are **very** slow! +5. You can run some kind of performance tests by using `perfs.jmx` in Apache JMeter + +See also [the Quarkus version](https://git.spacefox.fr/spacefox/perftests-quarkus). + +Requirements: + +- JRE ⩾ 21 +- PostgreSQL (you may use `src/test/docker/compose.yaml`) + +Generated arborescence kind of follow the hexagonal / ports & adapters architecture: + +``` +fr.spacefox.perftests.springboot + .core + .port + .data + EntityNDatasourcePort.java + .serviceN + .model + ModelN.java + ServiceN + .data + .entityN + EntityN.java + EntityNRepository.java + Mapper.java + .rest + .endpointN + .schema + SchemaN.java + EndpointNResource.java + Mapper.java + PerftestsSpringbootApplication.java ++ tests +```