Read the french version LISEZ-MOI.md
Id-fix api is a service that receives bal format data, handles it and send it to the ban-plateforme. Depending on whether the district is using the ban-id or not, id-fix will send the data to the ban-plateforme legacy api or use the ban-plateforme ban-id api. In the second case, id-fix will detect the data to create, to modify and to delete. It will also format it to the correct structure to use ban-id api.
Choose from a Docker or a local installation :
- Docker
- Docker-compose
Instructions on how to install the api (dev mode) :
- Clone this repository
- Start the docker container :
docker-compose up --build -d- Node (v18 or higher)
- NPM
Instructions on how to install the api (dev mode) :
- Install dependencies
npm install- Start the api :
npm run devI. Init a bal csv into the ban-plateforme using the id-fix bal processing.
Prerequisite : the district data of the bal to import needs to be already present in the ban db. If not, use the POST /district api to create it.
Here is the command to use :
npm run initBALIntoBAN path/to/BAL-file.csvreplace "path/to/BAL-file.csv" to the actual path of the bal csv to process and insert into the ban
This project uses the winston logging library for logging. The configuration of the logger is defined in the logger.ts file.
In development mode (when NODE_ENV is not set to production), the logger outputs the logs to the console.
In production mode (when NODE_ENV is set to production), the logger writes the logs to a file using the winston-daily-rotate-file library. The log files are rotated daily and are stored in the logs directory. The filename of the log files is in the format id-fix-YYYY-MM-DD.log. For more details about the rotation settings (max file size, max number of file, ...), please refer to the logger.ts file.
The logs are formatted in JSON and each log entry includes a timestamp.
This project is licensed under the MIT License - see the LICENSE file for details.
Express TypeScript Docker Docker Compose ESLint Prettier