aaaalabs / aaaalabs/arkify

Add more diverse example YAML files

Open
#3 1 comment 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Python
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

**Description:**
Create 5+ diverse project examples showing Arkify's versatility across different project types.

**Examples needed:**
- [ ] Mobile app project (React Native, Flutter, Swift)
- [ ] API/backend service (Node.js, Django, Rails)
- [ ] Chrome extension
- [ ] Open source library/package
- [ ] Freelance client work
- [ ] E-commerce site
- [ ] Developer tool/CLI

**Todo:**
- Create new YAML files in `examples/` folder
- Use real or realistic project data
- Include all required fields (name, hours, cost, tech_stack, learning)
- Optionally include extended fields (results, expectations vs reality)
- Test with: `python arkify.py examples/your-project.yaml`

**Good for:** First-time contributors, anyone who's built side projects!

**Template:**
```yaml
project:
name: "Your Project Name"
tagline: "One-line description"
hours: 42
cost: 100
tech_stack:
- "Tech 1"
- "Tech 2"
- "Tech 3"
- "Tech 4"
learning: "Your key insight"
```

See existing examples in `examples/` folder for inspiration!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.