SSX Monorepo Chores (#17)

* move changesets to devDependencies * Remove example repos from yarn workspace * removed .npmrc * added readme for running examples * add examples back * added serverless * Apply suggestions from code review Co-authored-by: Juliano <[email protected]> * add compatibility note Co-authored-by: Juliano <[email protected]>
spruceid · Nov 14, 2022 · dfc4fb8 · dfc4fb8
1 parent 1072382
commit dfc4fb8
Show file tree

Hide file tree

Showing 5 changed files with 2,926 additions and 9,823 deletions.
diff --git a/examples/Readme.md b/examples/Readme.md
@@ -0,0 +1,32 @@
+# SSX Examples
+## Overview
+This directory contains examples of how to use the various packages in the SSX Monorepo. The examples can be run standalone or together.
+
+Frontend examples include 
+- `ssx-test-dapp`
+- `ssx-test-react-dapp`
+
+Backend examples include
+- `ssx-test-express-api`
+- `ssx-test-http-api`
+- `ssx-test-serverless-dynamodb-api`
+
+
+## Running the examples
+To run the examples, you'll need to build the packages first. The best way to do that is in the root of the repo:
+```sh
+yarn ci
+# OR
+yarn && yarn build
+```
+
+Then, you can run ssx-test-dapp and ssx-test-express-api:
+```sh
+# From the root of the repo
+yarn run-examples
+# OR
+yarn test-dapp start
+yarn express-api start
+```
+
+The ssx-test-dapp is compatible with any example backend and is a good way to test them.