CSML-by-Clevy / csml-server-local-example

Example project to run the CSML engine locally with Node.js, Docker and MongoDB

Home Page:https://csml.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CSML Server - local development example

This is a demo project to show you how to run the CSML engine locally with node.js, docker and mongodb.

Requirements

This project requires Node.js (v12+) and Docker (including docker-compose). It will also automatically setup a MongoDB database in docker, but you are free to use any existing, supported database by modifying the relevant parameters in the docker-compose.yml file.

Setup

# setup all the node dependencies
npm install

# spin up the CSML engine on port 5000 and a MongoDB database
docker-compose up -d

Usage

An example request is ready to use in the index.js file, but you are free to use cURL or any other HTTP request library to call your CSML server instance. You can find more examples on the main CSML repository and on the official documentation.

The full API documentation is available in Swagger/OpenAPI format.

About

Example project to run the CSML engine locally with Node.js, Docker and MongoDB

https://csml.dev


Languages

Language:JavaScript 100.0%