Guitar World 🎸

A beginner-friendly guitar learning web application built with React, TypeScript, and Express in a modern monorepo setup.

• Frontend: React + TypeScript + Vite
• Backend: Express + TypeScript + Node.js
• Database: PostgreSQL + Prisma (coming soon)
• Monorepo: pnpm + TurboRepo
• Linting: ESLint + Prettier
• Git Hooks: Husky + lint-staged + commitlint
• CI/CD: GitHub Actions

guitar-world/
├── apps/
│   ├── web/          # React frontend (Vite)
│   └── api/          # Express backend
├── packages/
│   ├── config/       # Shared ESLint/Prettier configs
│   └── tsconfig/     # Shared TypeScript configs
├── .github/
│   └── workflows/    # GitHub Actions CI
└── package.json      # Root workspace config

• Node.js 18+
• pnpm 8+

1. Install dependencies:

   pnpm install

2. Setup git hooks:

   pnpm prepare

Run both frontend and backend in development mode:

pnpm dev

This will start:

• Web app at http://localhost:3000
• API server at http://localhost:3001

Run frontend only:

pnpm --filter @guitar-world/web dev

Run backend only:

pnpm --filter @guitar-world/api dev

Build all apps:

pnpm build

Run type checking:

pnpm typecheck

Run linting:

pnpm lint

Run tests:

pnpm test

Format code:

pnpm format

• GET / - API info
• GET /healthz - Health check (returns { status: "ok" })

1. Create a feature branch
2. Make your changes
3. Commit using conventional commits (enforced by commitlint)
4. Push your branch
5. Create a pull request

This project uses conventional commits:

feat: add new guitar tuner feature
fix: resolve chord recognition bug
docs: update API documentation

GitHub Actions automatically runs on pull requests:

• Type checking
• Linting
• Testing
• Building

1. Fork the repository
2. Create your feature branch (git checkout -b feat/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feat/amazing-feature)
5. Open a Pull Request

This project is licensed under the MIT License.