speckle-server/packages/server

Speckle Server

Status

Disclaimer

We're working to stabilize the 2.0 API, and until then there will be breaking changes.

Documentation

Comprehensive developer and user documentation can be found in our:

📚 Speckle Docs website

Introduction

The Speckle Server is a node application tested against v12. To start it locally:

First, ensure you have postgres and redis ready and running (check the readme.md from the root of the git repo).

NOTE: If you install PostgreSQL yourself or use an existing PostgreSQL instance, make sure to create a database for speckle and a user that can access it.

You can set it up with:

create user speckle with encrypted password ‘speckle’;
CREATE DATABASE speckle;
grant all privileges on database speckle to speckle;

If you use a network-accessible PostgreSQL instance, make sure to secure it with a stronger password and to configure the .env file accordingly

Finally, in the packages/server folder:

• copy the .env-example file to .env,
• If you have a custom setup, open and edit the .env file, filling in the required variables,
• run npm install,
• finally npm run dev,
• check localhost:3000/graphql out!

For more setup details and options, check out our Server Setup Docs

Developing

The server consists of several semi-related components, or modules. These can be found in /modules. Module composition:

• an index.js file that exposes two functions, init and finalize (mandatory)
• a graph folder, with two subfolders, namely resolvers and schemas (optional - these will be picked up and merged).

Server & Apps

Frontend

• In development mode, the Speckle Server will proxy the frontend from localhost:3000 to localhost:8080. If you don't see anything, ensure you've run npm run dev in the frontend package.

• In production mode, a load balancer should send requests either to the frontend nginx container or the server container, depending on the requested path

GraphIQL

A GraphIQL app is available for authenticated api exploration at localhost:3000/explorer. Note that for the authentication flow to work, you need to have the frontend running first.

GraphQL Playground

For non-authenticated api exploration, you can use the Graphql Playground which is available by default at localhost:3000/graphql.

Testing

To run all tests, simply run npm run test. To run specific tests, use the mocha --grep @subset syntax. For example:

• mocha --grep @auth --watch to run tests pertaning to the auth module only in watch mode.
• mocha --grep @core-streams --watch to run tests pertaining to stream related services.

Community

The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.