dehaze

Setting up project

This section talks in-depth about setting up a frontend or backend project to use Space Cloud in your preferred language.

Note: Make sure you have already deployed Space Cloud.

Available options

Space Cloud supports both GraphQL and REST (HTTP and WebSockets) APIs so that you can stick to what you find comfortable.

GraphQL API

GraphQL is the recommended way to use Space Cloud. It unlocks incredible powers like joins which are not exposed by REST APIs yet.

You can use any GraphQL client out there to talk to Space Cloud. However, it’s always recommended to use a popular open-source client (e.g. Apollo).

Follow this guide to set up Apollo client (recommended for graphql) in your javascript project.

Note: The file storage and user management APIs are only available via REST APIs as of now.

REST API

You can use the REST APIs of Space Cloud if you are more comfortable with REST. For file storage and user management module, REST is the only option as of now.

To make it easy to consume the REST APIs in web projects, we have created a Javascript SDK which consumes REST APIs internally.

Follow this guide to set up Javascript SDK in your project.

Have a technical question?

Improve the docs!