@@ -8,7 +8,7 @@ Naming backend is a web application implemented as a REST style web service back
...
@@ -8,7 +8,7 @@ Naming backend is a web application implemented as a REST style web service back
See `docs` and sub folders to learn how ESS Naming Convention is implemented in Naming backend
See `docs` and sub folders to learn how ESS Naming Convention is implemented in Naming backend
* what an ESS name is and how to think about it (to better understand how to work with it)
* what an ESS name is and how to think about it (to better understand how to work with it)
* concept & terminology
* concepts & terminology
* application & database, architecture & design
* application & database, architecture & design
* flow of code
* flow of code
* user & developer perspectives
* user & developer perspectives
...
@@ -89,11 +89,11 @@ Thereafter a number of http requests (GET) and curl commands (POST, PUT, PATCH,
...
@@ -89,11 +89,11 @@ Thereafter a number of http requests (GET) and curl commands (POST, PUT, PATCH,
* Not yet
* Not yet
* Authentication / Authorization
* Authentication / Authorization
* Flyway
* Flyway
* If tools need to be installed or upgraded, recommendation is to install or upgrade to most recent versions that are available, unless otherwise stated.
* Configuration
* Configuration
* Application and database may be started separately, with or without Docker, in which case configuration set by environment variables, docker compose files and `application.properties` must reflect this. An example of this is hostname/ip address/port for database that is to be available for application. Configuration must not be in conflict with environment in which application and database run.
* Application and database may be started separately, with or without Docker, in which case configuration set by environment variables, docker compose files and `application.properties` must reflect this. An example of this is hostname/ip address/port for database that is to be available for application. Configuration must not be in conflict with environment in which application and database run.
* If tools need to be installed or upgraded, recommendation is to install or upgrade to most recent versions that are available, unless otherwise stated.
* Pre-populated database to be available if data to be available at start of application. Otherwise database may be populated through `curl` at command line or Swagger UI.
* Pre-populated database to be available if data to be available at start of application. Otherwise database may be populated through `curl` at command line or Swagger UI.
* See `src/test/resources` and sub folders for database scripts. This includes scripts for database schema, migration and example content.
* See `src/main/resources` and `src/test/resources` and sub folders for database scripts. This includes scripts for database schema, migration and example content.
* If no prior database is available, see integration tests for examples on how to populate database. E.g. tests may be debugged and database content may be examined at any debug point. It's possible to backup database at such debug point and later restore it outside test. In such way, database may be set to state of choice.
* If no prior database is available, see integration tests for examples on how to populate database. E.g. tests may be debugged and database content may be examined at any debug point. It's possible to backup database at such debug point and later restore it outside test. In such way, database may be set to state of choice.
```
```
...
@@ -104,6 +104,6 @@ Thereafter a number of http requests (GET) and curl commands (POST, PUT, PATCH,
...
@@ -104,6 +104,6 @@ Thereafter a number of http requests (GET) and curl commands (POST, PUT, PATCH,
#### Recommentation
#### Recommentation
* Have local docker-compose files
* Have local docker-compose files - `.gitignore` contains `docker-compose-local*`
* for application and database together that may contain local configuration
* for application and database together that may contain local configuration
* for database alone if there is need to backup or restore database
* for database alone if there is need to backup or restore database
