docker-compose up -d content-transformer --buildpnpm iExecute the following command :
cp .env.template .envThen modify .env file to suit your needs (all variables are optional and can be removed) :
- PORT (default: 3000): port number on which the service is listening for transformation request
- METRICS_PORT (default: 3001): port number on which the service is listening to serve the metrics
- NB_THREADS (default: number of CPUs): number of concurrent services that will handle transformation requests. In development environments it is best to set this value to 1. In production, it should be set to the number of available CPUs (or removed from .env file, which will have the same effect)
- MAX_BODY_SIZE (default: 2mb): the maximum size of a request body. Beyond the specified limit, the request will be rejected.
pnpm run buildpnpm run devTo transform an HTML to JSON:
curl -L -X POST 'http://localhost:3000/transform' -H 'Content-Type: application/json' -d '{
"requestedFormats": ["json"],
"contentVersion": 0,
"htmlContent": "<span>Le lorem ipsum est, en imprimerie, une suite de mots sans signification utilisée à titre provisoire pour calibrer une mise en page<br><h1>Hello world</h1><br><a href=\"https://www.website.com\">Website</a>"
}'To transform an HTML to PLAIN TEXT:
curl -L -X POST 'http://localhost:3000/transform' -H 'Content-Type: application/json' -d '{
"requestedFormats": ["plainText"],
"contentVersion": 0,
"htmlContent": "<span>Le lorem ipsum est, en imprimerie, une suite de mots sans signification utilisée à titre provisoire pour calibrer une mise en page<br><h1>Hello world</h1><br><a href=\"https://www.website.com\">Website</a>"
}'To clean an HTML:
curl -L -X POST 'http://localhost:3000/transform' -H 'Content-Type: application/json' -d '{
"requestedFormats": ["html"],
"contentVersion": 0,
"htmlContent": "<span>Le lorem ipsum est, en imprimerie, une suite de mots sans signification utilisée à titre provisoire pour calibrer une mise en page<br><h1>Hello world</h1><br><a href=\"https://www.website.com\">Website"
}'To transform a JSON to HTML and PLAIN TEXT:
curl -L -X POST 'http://localhost:3000/transform' -H 'Content-Type: application/json' -d '{
"requestedFormats": [
"html",
"plainText"
],
"contentVersion": 0,
"jsonContent": {
"type": "doc",
"content": [
{
"type": "paragraph",
"attrs": {
"textAlign": "left"
},
"content": [
{
"type": "text",
"text": "Le lorem ipsum est, en imprimerie, une suite de mots sans signification utilisée à titre provisoire pour calibrer une mise en page"
}
]
}
]
}
}'To access metrics:
curl -L -X GET 'http://localhost:3000/metrics'Healthcheck :
curl -L -X GET 'http://localhost:3000/healthcheck'Load testing are run by launching load-tester container. This container can be customized by changing its environment variables :
ROOT_URL, the root URL of the content transformer to load test (shoul be kept tohttp://content-transformer:3000to test your local service)DATA_ROOT_PATH, should not be changedDURATION, the duration of the testVUS, the number of virtual users (see official documentation for more information)
docker-compose up -d content-transformer --build # To start your container with the latest version of your local source
docker-compose run --rm load-tester run src/index.js # Starts the testsTo add more files to the test set, add html files in test/data/big or test/data/small (depending on its size) and make sure to change the way smallHtmls and bigHtmls are loaded in index.ts.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent