Skip to content

Commit e4ce2a7

Browse files
committed
Update READMEs
1 parent d27c483 commit e4ce2a7

File tree

2 files changed

+17
-22
lines changed

2 files changed

+17
-22
lines changed

opensaas-sh/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Inception :)!
1212

1313
Since the demo app is just the open saas template with some small tweaks, and we want to be able to easily keep it up to date as the template changes, we don't version (in git) the actual demo app code, instead we version the diffs between it and the template: `app_diff/`.
1414

15-
**Quick Reference:**
15+
#### Workflow
1616

1717
- Generate `app/` from template and diffs: `./tools/patch.sh`
1818
- Update diffs after modifying `app/`: `./tools/diff.sh`

template-test/README.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,33 @@
11
# Template Testing
22

3-
Tests the production version of the Open SaaS template that users get from `wasp new -t saas`.
3+
Tests the production version of the Open SaaS template that users get from `wasp new app -t saas`.
44

5-
**Why this exists:** opensaas-sh tests `template/app` (current repo state), but `main` branch may differ from the last released template. This tests what users actually get from `wasp new -t saas`.
5+
**Why this exists:** As a part of our release checklist, we want to test that the production version of the Open SaaS template works.
66

7-
**How it works:** Scripts run `wasp new -t saas` to get a fresh template, then apply minimal production patches (Dummy→SendGrid email, dotenv-vault for secrets). Tests that the template builds and runs with production email provider.
7+
**How it works:** We create a new Wasp app from the production Open SaaS template, and then modify the app to be production-ready (e.g. replace `Dummy` email service with `SMTP`, add Dotenv Vault with real credentials, etc.).
88

9-
## Regular Usage
9+
## Testing a new Wasp release
1010

1111
When testing a new Wasp release:
1212

1313
```bash
1414
cd template-test
15+
# Create a new Wasp app and apply our patches to it.
1516
./tools/patch.sh
16-
cd app && npm run env:pull
17-
wasp start # or wasp build
18-
```
19-
20-
## Initial Setup
21-
22-
Only needed once to create the initial patches:
2317

24-
```bash
25-
cd template-test
26-
wasp new -t saas temp && cp -r temp/app/* app/ && rm -rf temp
27-
cd app && git init && git add .
18+
cd app
2819

29-
# Edit main.wasp: change Dummy→SendGrid
30-
# Setup dotenv-vault with working credentials
20+
# Get the environment variables from Dotenv Vault.
21+
npm run env:pull
3122

32-
cd .. && ./tools/diff.sh
33-
git add app_diff/ && git commit -m "Add template-test patches"
23+
wasp db start
24+
wasp db migrate-dev
25+
wasp start
3426
```
3527

36-
## Requirements
28+
### Workflow
29+
30+
- Generate `app/` from template and diffs: `./tools/patch.sh`
31+
- Update diffs after modifying `app/`: `./tools/diff.sh`
3732

38-
MacOS users need: `brew install coreutils gpatch diffutils`
33+
For detailed information about the diff/patch workflow and MacOS setup requirements, see [../tools/README.md](../tools/README.md).

0 commit comments

Comments
 (0)