Quickstart

It’s easy to get started with CloudSeed. We’ll walk you through it.

The Codebase

The code is hosted from a private git repo. You can access it from the Account page with an active subscription.

The code itself is split into 3 Services:

  • App (.NET Core) - The core application logic
    • App.Tests - Tests for App and its dependencies
  • Web (sveltekit) - A thin UI client to interact with App
  • DB (Postgres) - A container that makes it easy to spin up a live, local DB for development and testing

Each Service aims to be simple, flexible, and powerful - including everything you need without getting in the way of extensions or configuration.

Running CloudSeed

To run CloudSeed locally, we’ll leverage docker-compose to spin up each Service within its own container.

From the root of your CloudSeed repo, run:

sudo docker-compose down --remove-orphans && sudo docker-compose build && sudo docker-compose up

If all goes smoothly, you should be able to access each service at:

  • App - localhost:5001
  • Web - localhost:5000
  • DB - localhost:5002

Testing CloudSeed

CloudSeed’s approach to testing is to first create an environment as close to real-world as possible then test against that. To do so, it comes with a comprehensive test suite that runs against App and a live DB.

First, let’s start a local DB so we can test live data integrations. This will need to stay running during testing. From CloudSeed root, run:

sudo docker-compose -f docker-compose.test.yml down --remove-orphans && sudo docker-compose -f docker-compose.test.yml up cloudseed_business_test_database

Next we’ll spin up our tests. In a new terminal from CloudSeed root, run:

sudo docker-compose -f docker-compose.test.yml build cloudseed_business_app_tests && sudo docker-compose -f docker-compose.test.yml up cloudseed_business_app_tests

You should see the test results written to the terminal.

Building your Business

You’re up and running with CloudSeed. Now it’s up to you to build your business on top of it.

We’re constantly working on improving the CloudSeed codebase and its documentation for common problems. If you run into a problem or have any questions, create an Issue on the git repo or contact us - we’ll get back to you as soon as we can.