JumbaLiar

JumbaLiar is a frontend and backend that allows the user to quickly generate mockdata using dynamically generated express endpoints.

DEPRECATED

JumbaLiar 2.0 is now in development, go check it out!

Prerequisites

• Angular CLI (npm install @angular/cli -g if you do not already have it.) • Docker Compose

Install

cd into the root of the repository and type npm install (or npm i).
The install script will install both of the frontend and backend dependencies into their respective folders.

Start

In the root directory, run npm start.
This will start both the frontend and backend servers. The frontend will be built using AOT and may take some time to finish. Please be patient.

Ports

• Backend http://localhost
• Frontend http://localhost:8086

Special Thanks

• bbisping for his awesome redesign of the frontend to make it the JumbaLiar it is today.

Notes

"FULL" Method

When specifying a CRUD method, you can set the method to "FULL". This will set up full CRUD on the endpoint and generate unique audited information when a POST and PUT are made to the endpoint.
• GET (getAll) /services/<endpoint> (no body)
• POST (create) /services/<endpoint>/<id> (body)
• GET (read) /services/<endpoint>/<id> (no body)
• PUT (update) /services/<endpoint>/<id> (body)
• DELETE (delete) /services/<endpoint>/<id> (no body)

Interpolation

When adding values to the return objects/arrays, you can interpolate the values you'd like to return using the following syntax:
{{<endpoint>[index].[key]}}

The index is optional. If not specified, it will return an array. For instance, if you had another endpoint called "organization" and you wanted to get the first index's "id", you could interpolate {{organization[0].id}}. If you wanted to return the whole organization object, you can interpolate {{organization[0]}}

Dockerhub Description

Example docker-compose.yml

jumbaliar_frontend:
    image: kyjus25/jumbaliar-frontend
    restart: always
    environment:
	    - BACKEND_URL=http://localhost
    ports:
	    - 8086:80
jumbaliar_backend:
    image: kyjus25/jumbaliar-backend
    restart: always
    volumes:
	    - ./config.json:/node/config.json
	    - ./proxy.json:/node/proxy.json
	ports:
	    - 80:80

Note

• config.json must exist as a volume. This is what holds all the data. Create a blank config.json with an empty array ([]) inside it.
• restart:always on the backend is essential to how the system works. Express must be restarted when new endpoints are added.
• Backend URL must match the URL of jumbaliar_backend.
• proxy.json is optional. If you want to proxy 404s, this should contain an array of backends with no trailing slash.