Updated readme

This commit is contained in:
Daniel López García
2021-06-23 12:19:55 +02:00
committed by GitHub
parent 6815c3816a
commit f18f6d882b
+3 -3
View File
@@ -1,5 +1,5 @@
# Backend dev technical test # Backend dev technical test
We want to offer a new feature to our customers showing similar products to the one they are browsing. To do this we agreed with out front end applications to create a new REST API that will provide them the product detail of the similar products to a given one. [Here](./similarProducts.yaml) is the contract we agreed. We want to offer a new feature to our customers showing similar products to the one they are seeing. To do this we agreed with our front-end applications to create a new REST API that will provide them the product detail of similar products to a given one. [Here](./similarProducts.yaml) is the contract we agreed.
We already have an endpoint that provides the product Ids similar to a given one. We also have another endpoint that returns the product detail by productId. [Here](./existingApis.yaml) is the documentation of the existing APIs. We already have an endpoint that provides the product Ids similar to a given one. We also have another endpoint that returns the product detail by productId. [Here](./existingApis.yaml) is the documentation of the existing APIs.
@@ -12,7 +12,7 @@ Note that _Test_ and _Mocks_ components are given, you must only implement _your
## Testing and Self-evaluation ## Testing and Self-evaluation
You can run the same test we will put through your application. You just need to have docker installed. You can run the same test we will put through your application. You just need to have docker installed.
First of all you may need to enable file sharing for the `shared` folder on your docker dashboard -> settings -> resources -> file sharing. First of all, you may need to enable file sharing for the `shared` folder on your docker dashboard -> settings -> resources -> file sharing.
Then you can start the mocks and other needed infrastructure with the following command. Then you can start the mocks and other needed infrastructure with the following command.
``` ```
@@ -30,4 +30,4 @@ Browse [http://localhost:3000/d/Le2Ku9NMk/k6-performance-test](http://localhost:
The following topics will be considered: The following topics will be considered:
- Code clarity and maintainability - Code clarity and maintainability
- Performance - Performance
- Resilence - Resilence