generated from ludops/ludops-skeleton
78 lines
1.8 KiB
Markdown
78 lines
1.8 KiB
Markdown
# Quick Start Guide
|
|
|
|
Get the Todo app running in 5 minutes!
|
|
|
|
## Prerequisites
|
|
|
|
- Docker Desktop (running) **← Make sure this is started!**
|
|
- Node.js (v18+)
|
|
- pnpm (`npm install -g pnpm`)
|
|
|
|
## Setup Commands
|
|
|
|
```bash
|
|
# 1. Install dependencies
|
|
pnpm install
|
|
|
|
# 2. Start database (Docker must be running!)
|
|
pnpm db:up
|
|
|
|
# 3. Wait 10 seconds for database to initialize, then create tables
|
|
pnpm db:push
|
|
|
|
# 4. Start dev servers
|
|
pnpm dev
|
|
```
|
|
|
|
Open http://localhost:5173 🎉
|
|
|
|
## Troubleshooting
|
|
|
|
### "Cannot connect to database"
|
|
- Make sure Docker Desktop is running
|
|
- Check if database container is up: `docker ps`
|
|
- If not listed, run: `pnpm db:up`
|
|
|
|
### "pnpm db:push" fails
|
|
- Wait 10-15 seconds after starting database
|
|
- The database needs time to initialize
|
|
- Try running `pnpm db:push` again
|
|
|
|
## What You'll See
|
|
|
|
1. **Timeline** - Shows your tasks across 45 days (15 past, 30 future)
|
|
2. **Today's Tasks** - Essential tasks always visible, "When I have time" tasks collapsible
|
|
3. **Create Task Button** - Add new tasks with:
|
|
- Name (60 char max)
|
|
- Repeats (yes/no)
|
|
- Frequency (days/weeks/months/years)
|
|
- To do today (yes/no)
|
|
- Priority (Essential / When I have time)
|
|
|
|
## Task Actions
|
|
|
|
- **✓ Complete** - Marks task done (updates `last_completed_on`)
|
|
- **↻ Renew** - Resets task to do again today
|
|
|
|
## Sample Tasks to Try
|
|
|
|
1. **Daily workout** - Repeats every 1 day, Essential
|
|
2. **Weekly review** - Repeats every 1 week, Essential
|
|
3. **Clean garage** - No repeat, When I have time
|
|
4. **Monthly backup** - Repeats every 1 month, Essential
|
|
|
|
## Stopping
|
|
|
|
```bash
|
|
# Stop database
|
|
pnpm db:down
|
|
|
|
# Stop dev servers
|
|
Ctrl+C in both terminal windows
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
- See [SETUP.md](./SETUP.md) for detailed documentation
|
|
- Check [README.md](./README.md) for deployment instructions
|