Initial Ralph scaffold
This commit is contained in:
49
README.md
Normal file
49
README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# nick-tracker
|
||||
|
||||
Multi-source task capture system that ingests tasks from manual web form, REST API, email (IMAP/Microsoft Graph), and ConnectWise Manage sync into an unprocessed inbox for later GTD clarification
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Language**: TypeScript
|
||||
- **Runtime**: Node.js 20
|
||||
- **Framework**: NestJS 10
|
||||
- **Testing**: Jest (backend), Vitest (frontend)
|
||||
- **Build**: Docker Compose, pnpm workspaces, tsup
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Read `PROMPT.md` for full project requirements
|
||||
2. Follow `GUIDE.md` for step-by-step instructions
|
||||
3. Track progress in `prd.json`
|
||||
|
||||
## Development with Ralph Method
|
||||
|
||||
```bash
|
||||
# Start a Ralph loop to implement this project
|
||||
/ralph-wiggum:ralph-loop "$(cat PROMPT.md)" --max-iterations 50 --completion-promise "PROJECT_COMPLETE"
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── PROMPT.md # Main Ralph prompt
|
||||
├── prd.json # Feature tracking
|
||||
├── progress.txt # Progress log
|
||||
├── GUIDE.md # Step-by-step guide
|
||||
├── CLAUDE.md # Claude Code config
|
||||
├── docs/ # Documentation
|
||||
│ ├── idea-dump.md
|
||||
│ ├── architecture.md
|
||||
│ ├── features.md
|
||||
│ └── ...
|
||||
├── agent_docs/ # Agent context
|
||||
│ ├── tech_stack.md
|
||||
│ ├── code_patterns.md
|
||||
│ └── testing.md
|
||||
└── src/ # Source code
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
*Generated with [Ralph PRD Generator](https://github.com/your-username/ralph-vibe)*
|
||||
Reference in New Issue
Block a user