Start your experience
Welcome to Solidground Docs. Let’s get started with the Solidground tool suite.
Solidground helps ease the design and creation of solutions for the Social Web. Solidground offers Social experience design (SX), an inclusive method that guides a client and creator through a highly collaborative process. The main focus is on needs-based evolution where the needs of all stakeholders are central throughout the entire solution lifecycle.
Before delving in, it is advisable to read more background on Social experience design and how Solidground helps you practice it. Out of the box the Solidground tool suite provides an opinionated set of practices to solution design. We recommend to start with the default tool configuration and gradually customize the development method to personal preferences.
Client and creator
The documentation uses the terminology of “client” and “creator” to divide into groups of those who need a solution, the “domain experts” and often non-technical people, and those who build it, the technical people in IT roles. Both of these groups are stakeholders that have needs with regards to the solution, that must be taken into account. Solidground considers the client and creator to be part of the same social network for the duration of the solution lifecycle.
Clients and creators are fully independent parties. A client can use the services of multiple creators, and creators can serve multiple clients. The Floorplanner Design Workspace keeps track of all ongoing projects and the relationships between clients and creators.
Three key tools provide the highly integrated development environment. These are:
- Groundwork Hosting: Social network infrastructure to integrate and host social experiences.
- Floorplanner Designer: Online collaboration for client and creator to iterate on solutions.
- Taskweave Engine: Workflow manager that facilitates both solution and tool processes.
In addition the creator has two additional productivity tools to their disposal:
- Weave CLI: Command-line interface provides direct access to much of the functionality.
- Weave SDK: Software development kit to bootstrap solution design in supported languages.
Working with Solidground involves setting up a local work environment and connecting to a collaboration hub.
Local tool set up
The client and creator can choose different work environments, adapted to their respective skill sets. The client typically only needs the design environment provided by Floorplanner Designer, while creators download the complete Solidground monorepo containing the entire tool suite as well as the source code to develop against.
The client has two options and can opt for local-first or web-based experience design.
Local-first design offers the best experience, and requires installation of an executable on the local computer. To start, download the release package to your computer, unpack the archive to a directory of choice, and run
The latest stable release of Solidground design environment is:
Create a directory “solidground” where you want to install, and navigate to it. Then find the latest Floorplanner Designer version in the Releases list for your architecture e.g.
floorplanner-designer-v0.1.0-linux-amd64.tar.gzand click in the UI to download and use
tar -xzto unpack the archive. Alternatively you can use
wgetfrom the command line (adapt to your preference):
wget -c http://codeberg.org/solidground/solidground/releases/downloads/floorplanner-designer-v0.1.0-linux-amd64.tar.gz -O - | tar -xz
Now you can start the designer by running
./floorplannerfrom the “solidground” directory.
Congratulations. You are now ready to sign up to a collaboration hub and create your Design Workspace. To do so just follow the onboarding procedure in the Designer and either select the Solidground Design Hub, or fill in the URL of your self-hosted collaboration hub, or one offered by a hosting provider.
For web-based experience design a regular web browser like Firefox, Chrome or Safari is sufficient. The address to navigate to depends on client preference for hosting their workspace.
Easiest option is to use the Solidground Design Hub, our own relay server that facilitates collaboration between clients and creators. Simply go to
design.solidground.workand sign up. After the onboarding procedure your Design Workspace is ready to go.
You may also opt for a collaboration hub of a 3-rd party provider. This may be the creator you work with, allowing you to sign up and who may also administer your design workspace for you and your stakeholders. Any self-hosted hub can function as hosting provider.
A collaboration hub can be hosted on premise or at an internet service provider. The client has full control of the server. The installation procedure requires some technical skills, and the client is responsible for maintenance tasks. See self-hosting a hub for installation procedure.
The installation of Solidground for development is straightforward. The git repository of the Solidground project contains everything that is required. To get started, first prepare your local development environment, then clone the full
solidground repository to the local computer and launch Floorplanner Designer using the
weave command-line interface:
git clone email@example.com:solidground/solidground.git
Upon first use
weave will run an interactive setup process. When done, the Floorplanner Designer launches in the Tauri toolkit and runs in developer mode. This installation procedure is enough to start collaborating with clients in early stages of the SX process that are supported by Floorplanner.
Some further steps are required in order to develop the code for a client solution. They involve setting up programming language support. There are two options to choose from:
A collaboration hub is a headless installation of Groundwork Hosting on a server. Hubs are part of the Social Web and can federate with each other. At least one collaboration hub is required to facilitate the collaboration between a client and a creator.
Solidground Design Hub
Solidground hosts their own collaboration hub at
design.solidground.work to help facilitate matchmaking and collaboration between clients and servers. The hub hosts the Floorplanner social experience, which can be used for web-based design by clients.
The Solidground Design Hub makes it easy to get started with your first experience designs. At any time it is possible to migrate your work to a collaboration hub that is self-hosted or offered by a 3rd-party hosting provider on the Social Web.
Self-hosted collaboration hub
We find the ability to self-host the entire Solidground tool suite to be important for a healthy ecosystem. After all the Social Web is inherently decentralized. Self-hosting is a need of both clients and creators, that we recognize. See the Groundwork Hosting guide for detailed instructions.