Module 3: Working with ProjectsLesson 2 of 6

Lesson 2·5 min

The CLAUDE.md File

Your project's instruction manual for Claude

The CLAUDE.md File

CLAUDE.md is the most important file for Claude Code. It tells Claude about your project, your preferences, and your rules.

What Goes in CLAUDE.md?

Terminal

$ cat CLAUDE.md

# Project: Byron Beans Website

## Overview

E-commerce website for an Australian coffee shop in Byron Bay.

## Tech Stack

- Next.js 14 with App Router

- Tailwind CSS

- Stripe for payments (AUD)

- Supabase for database

## Important Rules

- All prices in AUD with $ symbol

- Use Australian English spelling (colour, centre, organisation)

- Mobile-first responsive design

- Accessibility: WCAG 2.1 AA compliance

## Project Structure

- /app - Next.js app router pages

- /components - Reusable React components

- /lib - Utilities and helpers

- /public - Static assets

## Commands

- npm run dev - Start development server

- npm run build - Build for production

- npm test - Run tests

▌

Tip

Claude reads CLAUDE.md automatically when you start a session. It's always in context!

Template

Here's a starter template:

markdown

# Project: [Your Project Name]

## Overview
[One paragraph describing what this project does]

## Tech Stack
- [Framework/language]
- [Database]
- [Key libraries]

## Important Rules
- [Your coding standards]
- [Naming conventions]
- [Business rules]

## Commands
- npm run dev - [what this does]
- npm test - [what this does]

## Notes
[Any other context Claude should know]

Real Examples

SaaS App

markdown

# Project: InvoiceFlow

## Overview
Invoice management for Australian small businesses.
Handles GST calculations, BAS preparation, ATO integration.

## Tech Stack
- Next.js 14, TypeScript
- PostgreSQL via Supabase
- Stripe (AUD currency)

## Business Rules
- GST is 10% on most items
- ABN must be 11 digits
- Date format: DD/MM/YYYY
- Currency: AUD with 2 decimal places

## Australian Compliance
- Privacy Act 1988 compliance required
- Data must stay in Australian region
- Super guarantee is 11.5%

Python Script

markdown

# Project: Price Scraper

## Overview
Scrapes Woolworths and Coles for grocery prices.
Compares prices and finds best deals.

## Tech Stack
- Python 3.11
- BeautifulSoup4
- SQLite for caching

## Rules
- Respect robots.txt
- Cache results for 24 hours
- Rate limit: 1 request/second

Aussie Note

Add Australian-specific requirements to CLAUDE.md! GST rules, Super percentages, FW compliance - whatever matters to your project. 🇦🇺

Updating CLAUDE.md

Keep it updated as your project evolves:

Terminal

> /chat

> Add to CLAUDE.md that we're now using Resend for emails

Claude: I'll update CLAUDE.md:

+ ## Email

+ - Using Resend for transactional emails

+ - From address: hello@byronbeans.com.au

▌

Warning

If CLAUDE.md gets too long (>100 lines), consider splitting into multiple files like ARCHITECTURE.md, STYLEGUIDE.md, etc.

Key Takeaways

CLAUDE.md is auto-loaded in every session
Include tech stack, rules, and project structure
Add Australian-specific requirements
Keep it updated as your project grows
Use clear headings for easy scanning

Creating a Project Folder

Adding Context to Your Project