franpcode/create-better-t-stack
1
0
Fork 0
mirror of https://github.com/FranP-code/create-better-t-stack.git synced 2025-10-12 23:52:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update contribution guide

Browse Source
This commit is contained in:
Aman Varshney
2025-09-12 23:57:48 +05:30
parent 63f700c356
commit 43c27df68a
3 changed files with 62 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
.github/CONTRIBUTING.md vendored
View File

@@ -47,15 +47,47 @@ This repository is organized as a monorepo containing:
3. **Start development server** 3. **Start development server**
```bash ```bash
bun dev:cli bun dev
``` ```
This runs the CLI in watch mode, automatically rebuilding on changes. This runs tsdown build in watch mode, automatically rebuilding on changes.
4. **Test the CLI**
Now go to anywhere else in your system (maybe like a test folder) and run:
```bash
create-better-t-stack
```
This will run the locally installed CLI.
### Web Development ### Web Development
1. **Start the documentation website** 1. **Install dependencies**
```bash ```bash
bun dev:web # from repo root
bun i
```
2. **Setup backend**
```bash
cd packages/backend
bun dev:setup # you can choose local development too in prompts
```
3. **Configure environment**
Copy the Convex URL from `packages/backend/.env.local` to `apps/web/.env`:
```
NEXT_PUBLIC_CONVEX_URL=http://127.0.0.1:3210/
```
4. **Set GitHub tokens**
Now run `bun dev` in the root. It will complain about GitHub token, so run this in `packages/backend`:
```bash
npx convex env set GITHUB_ACCESS_TOKEN=xxxxx
npx convex env set GITHUB_WEBHOOK_SECRET=xxxxx
```
5. **Start the documentation website**
```bash
bun dev
``` ```
This starts the Next.js development server for the documentation site. This starts the Next.js development server for the documentation site.
@@ -109,12 +141,9 @@ This repository is organized as a monorepo containing:
```bash ```bash
# For CLI changes # For CLI changes
cd apps/cli cd apps/cli
bun dev:cli bun dev
bun run test bun run test
# For web changes
bun dev:web
# Format files # Format files
bun run format bun run format
``` ```

1
apps/web/.env.example Normal file
View File

@@ -0,0 +1 @@
NEXT_PUBLIC_CONVEX_URL=

29
apps/web/content/docs/contributing.mdx
View File

@@ -34,15 +34,34 @@ bun install
cd apps/cli cd apps/cli
# optional global link for testing anywhere # optional global link for testing anywhere
bun link bun link
# run in watch mode # run in watch mode (runs tsdown build in watch mode)
bun dev:cli bun dev
``` ```
Now go to anywhere else in your system (maybe like a test folder) and run:
```bash
create-better-t-stack
```
This will run the locally installed CLI.
## Develop the Docs ## Develop the Docs
```bash ```bash
# from repo root # from repo root
bun dev:web bun i
cd packages/backend
bun dev:setup # you can choose local development too in prompts
```
Copy the Convex URL from `packages/backend/.env.local` to `apps/web/.env`:
```
NEXT_PUBLIC_CONVEX_URL=http://127.0.0.1:3210/
```
Now run `bun dev` in the root. It will complain about GitHub token, so run this in `packages/backend`:
```bash
npx convex env set GITHUB_ACCESS_TOKEN=xxxxx
npx convex env set GITHUB_WEBHOOK_SECRET=xxxxx
``` ```
## Contribution Flow ## Contribution Flow
@@ -56,11 +75,11 @@ bun dev:web
```bash ```bash
# CLI # CLI
cd apps/cli && bun dev:cli cd apps/cli && bun dev
cd apps/cli && bun run test cd apps/cli && bun run test
# Web # Web
bun dev:web bun dev
# Format # Format
bun run format bun run format