https://github.com/inseefr/massive-attack-back-office
Back-office services for Massive-Attack
https://github.com/inseefr/massive-attack-back-office
Last synced: 8 months ago
JSON representation
Back-office services for Massive-Attack
- Host: GitHub
- URL: https://github.com/inseefr/massive-attack-back-office
- Owner: InseeFr
- License: mit
- Created: 2021-05-12T15:17:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T21:17:19.000Z (over 1 year ago)
- Last Synced: 2024-12-05T21:28:01.831Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 1.06 MB
- Stars: 0
- Watchers: 10
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Massive-Attack Back-Office
API for the management of questionnaires and organizational data for Computer-Assisted Personal Interviewing (CAPI) Data Collection
REST API for communication with Queen-Back-Office and Pearl-Jam-Bak-Office.
Back-Office API for Massive-Attack-Front-Office
## Quick start :
### With docker :
- `docker run -p 8080:8080 -t inseefrlab/massive-attack-back-office`
To override environments variables you can do :
- `docker run -p 80:80 -e FR_INSEE.SABIANEDATA.API.HOST=http://override.value.com -t inseefrlab/massive-attack-back-office`
### With Maven - Requirements
For building and running the application you need:
- [JDK 17](https://adoptium.net/fr/temurin/releases/?version=17)
- Maven 3
### With Maven - Install and execute unit tests
Use the maven clean and maven install
```shell
mvn clean install
```
## With Maven - Running the application locally
Use the [Spring Boot Maven plugin](https://docs.spring.io/spring-boot/docs/current/reference/html/build-tool-plugins-maven-plugin.html) like so:
```shell
mvn spring-boot:run
```
## Application Accesses locally
To access to swagger-ui, use this url : [http://localhost:8080/api/swagger-ui.html](http://localhost:8080/)
## Deploy application on Tomcat server
### 1. Package the application
Use the [Spring Boot Maven plugin] (https://docs.spring.io/spring-boot/docs/current/reference/html/build-tool-plugins-maven-plugin.html) like so:
```shell
mvn clean package
```
The war will be generated in `/target` repository
### 2. Install tomcat and deploy war
To deploy the war file in Tomcat, you need to :
Download Apache Tomcat and unpackage it into a tomcat folder
Copy your WAR file from target/ to the tomcat/webapps/ folder
### 3. Tomcat config
Before starting up the tomcat server, some configurations are needed :
#### External Properties file
!!! => To be migrated to embedded Tomcat and env-var configuration
Create sabdatab.properties near war file and complete the following properties:
```properties
#Profile configuration
# Security : "keycloak" for keycloak impl, anything else => no auth
fr.insee.sabianedata.security=none
############# Swagger host #############
fr.insee.sabianedata.api.scheme=http
fr.insee.sabianedata.api.host=localhost:8080
############# Logging #############
logging.config=${catalina.base}/webapps/log4j2.xml
...