Mock HTTP server designed to assist frontend and mobile engineer candidates with their take-home assignment. It provides essential backend functionalities for testing and development purposes.
Before you can use this mock HTTP server, ensure you have the following software installed on your system:
-
Node.js: This project requires Node.js version 20 or higher. We recommend using NVM (Node Version Manager) to manage your Node.js installations. You can follow these steps to install Node.js with NVM:
-
Install NVM by following the instructions on the NVM GitHub repository.
-
Once NVM is installed, open a new terminal window and install Node.js version 20 using the following command:
nvm install v20
-
Set Node.js version 20 as the default for this project:
nvm use v20
-
-
Yarn: You can install Yarn globally using npm (Node Package Manager) with the following command:
npm install -g yarnOnce you have Node.js and Yarn installed as specified above, you'll be ready to set up and run the mock server.
To install the necessary dependencies for this mock HTTP server, navigate to the project directory in your terminal and run the following command:
yarn installThis will fetch and install all the required packages and dependencies for the project within the project directory.
After the installation is complete, you can further ensure that everything is set up correctly by running the tests using the following command:
yarn testA successful test run with all green results not only indicates that the installation and setup are correct but also assures that the running server is functioning as expected.
To start the mock HTTP server, along with specifying the Basic authentication password, use the following command within your project directory:
PASSWORD=examplepassword yarn startMake sure to replace examplepassword with your desired password. This command sets the required password via the PASSWORD environment variable and starts the server simultaneously.
By default, the server will be running on port 3000. If you want to specify an alternative port for the server, you can use the PORT environment variable. Here's an example of how to do so:
PASSWORD=examplepassword PORT=8080 yarn startReplace 8080 with the port number you prefer.
Once you've executed the command with the correct password and, if needed, an alternative port, the server will be launched and it will be ready to respond to incoming HTTP requests.
Certain endpoints utilize the Basic authentication scheme to authenticate clients. The accepted username is dayatani. As mentioned earlier, the password is specified by the PASSWORD environment variable, which you can set when starting the mock server.
For testing purposes, the server is designed to return a response with a status code of 500 when creating a farmer with the name segmentation-fault. This feature is specifically designed for testing error handling in your application.
We provide a comprehensive OpenAPI specification of the API, which details the expected request body and parameters, response statuses and bodies, as well as the authentication mechanism.
To access the API documentation, please refer to the openapi.yml file located in the project directory. This file contains a detailed description of the API endpoints, request and response formats, and the required authentication process.
By consulting the OpenAPI specification, you'll have a clear understanding of how to interact with the mock HTTP server and utilize its features effectively.
This project contains proprietary code, and all rights are reserved by PT DayaTani Digital Indonesia. Unauthorized use, reproduction, or distribution of this code is strictly prohibited.