Table of Contents
This guide will help you setup Space Cloud quickly on your local machine via its binary executable. It will guide you through exploring the Space Cloud APIs on MongoDB without having to set up any project.
If you instead want to start a project from scratch using Space Cloud, then check out the getting started guide.
Note: MongoDB is not a dependency of Space Cloud. We are using MongoDB in this guide for ease of use because of it’s schemaless nature.
The first step is to download the binary. You need to download the binary for your operating system or you could build it directly from its source code. You will need go version 1.13.0 or later to build it from source.
Download the binary for your OS from here:
You can unzip the compressed archive
For Linux / Mac:
unzip space-cloud.zip && chmod +x space-cloud
For Windows: Right click on the archive and select
To make sure if the binary is correct, type the following command from the directory where the binary is downloaded:
For Linux / Mac:
It should show something like this:
space-cloud-ee version 0.12.0
Note: Make sure your MongoDB is up and running before this point
To start Space Cloud in
dev mode, just copy paste the following command and hit enter:
For Linux / Mac:
./space-cloud run --dev
space-cloud.exe run --dev
You should be seeing something like this when Space Cloud starts:
Starting Nats Server Starting grpc server on port: 4124 2019/08/03 08:00:38 Syncman node query response error: failed to respond to key query: response is past the deadline Starting http server on port: 4122 Hosting mission control on http://localhost:4122/mission-control/ Space cloud is running on the specified ports :D
--devflag tells Space Cloud to run in dev mode (so that the admin UI does not asks for a username and password)
As you would have noticed, on running the binary, a
config.yaml file and a
raft-store folder would have been generated in the directory from where you had run it.
Space Cloud needs this config file in order to function. The config file is used to load information like the database to be used, its connection string, security rules, etc.
Space Cloud has it’s own Mission Control (admin UI) to configure all of this in an easy way.
Note: All changes to the config of Space Cloud has to be done through the Mission Control only. Changes made manually to the config file will get overwritten.
Head over to
http://localhost:4122/mission-control to open Mission Control.
localhostwith the address of your Space Cloud if you are not running it locally.
Create a Project button.
name to your project. MongoDB will be selected as your database by default. Keep it as it is for this guide.
Next to create the project. On creation of project you will be directed to the project overview screen.
Head over to the
Connection String input contains the default connection string of MongoDB which is
If your MongodDB isn’t running on this address, then paste the
connection string of your MongoDB over there and hit
Save button. That’s all what is required to configure Space Cloud for this guide!
Note: If you are using an SQL database, you should hit the
Set Up Databasebutton to create the internal tables which Space Cloud requires after saving the right connection string.
Our backend is up and running, configured to expose APIs on MongoDB. Time to explore it’s awesome powers.
Explore GraphQL APIs of Space Cloud using GraphiQL.