@everymundo/fake-config-server

@everymundo/fake-config-server

Simulates the config server for local development

Installation

npm install @everymundo/fake-config-server

Custom routes

Create a directory on your projects root folder to store your custom routes

mkdir -p resources/fake-routes

Add your .json files to that folder. The name of the file (excluding the .json) will be the path for the route. Example: you have a file named my-configs.json, so when you list the directory's content you can see that file

ls resources/fake-routes
my-configs.json

Configuration

Add the following scripts to your project's package.json file.

  "scripts": {
    "fake-config-server-start": "npm run fake-config-server-stop &> /dev/null; sleep 1; fake-config-server >> logs/fake-config-server.log 2>&1 & echo PID=$!",
    "fake-config-server-stop": "killall -9 fakeConfigServer",
  },

Don't forget to create the logs directory on your project's root folder, if you don't already have one.

mkdir logs

Running

After configuring your npm scripts you can just start the server with the command

npm run fake-config-server-start

To stop the server you can run

npm run fake-config-server-stop

Accessing it

By default the service will listen to all interfaces by using 0.0.0.0 and the default port is 54321. If you set the ENV VAR CONFIG_SERVER_PORT to a different number that will be the new port.

So, assuming you are using the default port number, if you go to http://0.0.0.0:54321/ you should see the default route that cames as an example.

Notice that the request will be redirected to http://0.0.0.0:54321/airfare-cadmus-service-v1

In order to use your my-configs.json file you must access http://0.0.0.0:54321/airfare-cadmus-service-v1/my-configs

If you access a non existing route it will show you a 404 JSON error with the available routes.