Skip to content

Commit 9820f3b

Browse files
committed
docs: polish open source project surface
1 parent fb87bb4 commit 9820f3b

10 files changed

Lines changed: 148 additions & 9 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @jesseoue

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions and ideas
4+
url: https://github.com/jesseoue/stackfoundry/discussions
5+
about: Use discussions for broad ideas, questions, and roadmap feedback.

.github/dependabot.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
- package-ecosystem: "npm"
8+
directory: "/"
9+
schedule:
10+
interval: "weekly"
11+
groups:
12+
production:
13+
dependency-type: "production"
14+
development:
15+
dependency-type: "development"

.github/labeler.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
docs:
2+
- changed-files:
3+
- any-glob-to-any-file:
4+
- "docs/**"
5+
- "*.md"
6+
7+
registry:
8+
- changed-files:
9+
- any-glob-to-any-file:
10+
- "registry.json"
11+
- "registry/**"
12+
- "public/r/**"
13+
14+
cli:
15+
- changed-files:
16+
- any-glob-to-any-file:
17+
- "apps/cli/**"
18+
19+
ci:
20+
- changed-files:
21+
- any-glob-to-any-file:
22+
- ".github/**"

.github/workflows/ci.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,16 @@ on:
88

99
permissions:
1010
contents: read
11+
pull-requests: write
1112

1213
jobs:
14+
label:
15+
if: github.event_name == 'pull_request'
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions/labeler@v6
20+
1321
check:
1422
runs-on: ubuntu-latest
1523
steps:

CODE_OF_CONDUCT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Code of Conduct
2+
3+
StackFoundry follows the Contributor Covenant Code of Conduct.
4+
5+
Be respectful, constructive, and focused on making the project better. Harassment, abuse, or discriminatory behavior is not welcome.
6+
7+
Report unacceptable behavior privately to the maintainer.

README.md

Lines changed: 57 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Install production SaaS modules as editable source code.
44

5+
[![CI](https://github.com/jesseoue/stackfoundry/actions/workflows/ci.yml/badge.svg)](https://github.com/jesseoue/stackfoundry/actions/workflows/ci.yml)
6+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
7+
[![Status: Experimental](https://img.shields.io/badge/status-experimental-orange.svg)](./ROADMAP.md)
8+
59
StackFoundry is a source registry for full-stack app modules: auth, billing, API keys, webhooks, analytics, docs, Drizzle schemas, tests, and deployment workflows.
610

711
Every module ships with the code and the operating instructions needed to maintain it.
@@ -10,7 +14,7 @@ No black boxes. No locked framework. Copy the code. Own the code.
1014

1115
## Status
1216

13-
This repository is the public seed for StackFoundry. The product is the registry and module installer. Presets are only bundles of modules.
17+
StackFoundry is experimental. The current repository contains the registry, the first installable modules, and a local CLI prototype. Presets are bundles of modules; modules are the product.
1418

1519
StackFoundry sits between three familiar ideas:
1620

@@ -44,6 +48,36 @@ The demo should show each module adding:
4448
- maintenance guidance
4549
- install metadata for future diff/update safety
4650

51+
## What Works Today
52+
53+
```bash
54+
node apps/cli/src/cli.mjs list
55+
node apps/cli/src/cli.mjs presets
56+
node apps/cli/src/cli.mjs validate
57+
node apps/cli/src/cli.mjs build
58+
node apps/cli/src/cli.mjs add api-keys --target ../some-app --dry-run
59+
node apps/cli/src/cli.mjs add preset next-saas --target ../some-app --dry-run
60+
node apps/cli/src/cli.mjs diff api-keys --target ../some-app
61+
```
62+
63+
Current installable modules:
64+
65+
- `drizzle-postgres`
66+
- `api-keys`
67+
- `stripe-billing`
68+
- `ai-chat`
69+
70+
Current presets:
71+
72+
- `next-saas`
73+
- `developer-platform`
74+
- `b2b-saas`
75+
- `ai-saas`
76+
- `internal-admin`
77+
- `free-tier-saas`
78+
- `vercel-native`
79+
- `cloudflare-native`
80+
4781
## V1 Golden Path
4882

4983
- `next-saas`
@@ -104,22 +138,37 @@ examples/
104138
docs/
105139
```
106140

141+
## Registry Output
142+
143+
The registry build writes public item JSON to:
144+
145+
```text
146+
public/r/
147+
registry.json
148+
api-keys.json
149+
drizzle-postgres.json
150+
stripe-billing.json
151+
presets/
152+
```
153+
107154
## Development
108155

109156
The current milestone is to make the first modules installable and safe to diff.
110157

111158
Current local prototype:
112159

113160
```bash
114-
node apps/cli/src/cli.mjs list
115-
node apps/cli/src/cli.mjs presets
116-
node apps/cli/src/cli.mjs validate
117-
node apps/cli/src/cli.mjs build
118-
node apps/cli/src/cli.mjs add api-keys --target ../some-app --dry-run
119-
node apps/cli/src/cli.mjs add preset next-saas --target ../some-app --dry-run
120-
node apps/cli/src/cli.mjs diff api-keys --target ../some-app
161+
pnpm check
121162
```
122163

123164
## Roadmap
124165

125166
See [`ROADMAP.md`](./ROADMAP.md).
167+
168+
## Contributing
169+
170+
See [`CONTRIBUTING.md`](./CONTRIBUTING.md). Module requests are welcome through GitHub issues.
171+
172+
## Security
173+
174+
See [`SECURITY.md`](./SECURITY.md).

docs/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# StackFoundry Docs
2+
3+
- [Registry](./registry.md)
4+
- [Modules](./modules.md)
5+
- [Providers](./providers.md)
6+
- [Maintenance instructions](./agents.md)
7+
8+
## Start Here
9+
10+
1. Read the [Registry](./registry.md) docs.
11+
2. Inspect the first modules in `registry/modules`.
12+
3. Run `node apps/cli/src/cli.mjs validate`.
13+
4. Try `node apps/cli/src/cli.mjs add api-keys --target /tmp/app --dry-run`.

docs/launch-checklist.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Launch Checklist
2+
3+
- [ ] README quick start tested from a clean checkout
4+
- [ ] `pnpm check` passes
5+
- [ ] demo GIF recorded with public demo data
6+
- [ ] example app deployed
7+
- [ ] repository description and topics configured
8+
- [ ] issue templates enabled
9+
- [ ] discussions enabled
10+
- [ ] branch protection enabled
11+
- [ ] secret scanning and push protection enabled
12+
- [ ] funding profile enabled
13+
- [ ] first roadmap issues created
14+
- [ ] module request issue created
15+
- [ ] no private data, internal planning files, or local env files tracked

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@
3030
"ai-sdk",
3131
"stripe",
3232
"clerk",
33-
"vercel"
33+
"vercel",
34+
"open-source",
35+
"developer-tools",
36+
"starter-kit",
37+
"fullstack"
3438
],
3539
"repository": {
3640
"type": "git",

0 commit comments

Comments
 (0)