Fluidspace Development Server v0.2

This server is a trimmed-down version of the Fluidspace backend for the purpose of easier and faster development of modules. It provides CRUD controller for Data and Props REST API.

It consists of an API client and MongoDB launched in a Docker container. You can use the API client without Docker if your development environment has PHP 7.4+, MongoDB and PHP-MongoDB driver installed.

Learn more: What is Fluidspace?

Installation video guide: YouTube

✋🏼 Pre-requisites

• Docker (with docker-compose)

🔧 Setup

1. Download this repository.

2. Copy the .env.example and save as .env.

3. Set the DEVELOPER_NAMESPACE and other env variables as required.
   Namespace is used to prefix all the module names. Must be space-less, lowercase and alphanumeric.
   Note: You can change the namespace for a new module from the web interface.

4. Rest of the fields can remain unchanged, by default MongoDB has no user and password.

🚀 Launching the server

docker-compose -p fluidspace-dev-server up -d 

First start may take a while as the container images are downloaded and packages are installed.

The web UI should be accessible on http://localhost:1822

The MongoDB instance can be connected via localhost:27027, ideally using mongosh or Compass.

The source code for Web UI is located at /usr/src/FluidspaceDevApi in the fluidspace-api-client docker container.

🤔 What Next?

Head-on to App or Integration template and start developing modules using VueJS.