Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.59 KB

README.md

File metadata and controls

49 lines (34 loc) · 1.59 KB

Agiliate Engine

The Agiliate Engine is a sophisticated computing engine designed to calculate the required office space for a company. It takes into account various parameters such as the number of employees, workspace types, and government regulations to provide an accurate estimation of the space needed.

Read this quick start file or the documentation to learn more about the Agiliate Engine.

There is a simple client application demonstrating the use of the engine here.

Configuration

The application's configuration parameters are stored in the default.json file. These parameters can be modified to suit the specific needs of your company. The configuration file to use is defined in the constructor of the Calculator class in src/calculator.js. You can also change the variables and constants in the request, as shown in the example Postman collection, postman_collection.json.

Installation and requirements

The application requires either Bun or Docker to run. If using Bun run

bun install

to install the dependencies. If using Docker Compose, run

docker compose up

to start the application. Or use

docker build -t agiliate-engine . && docker run -p 1337:1337 agiliate-engine

Development server

Start a development hot reload server with

bun run --watch src/index.ts

Running

Run the application with

bun run src/index.ts

Tests

Run the tests with

bun test