Skip to content

Commit 05ebe9b

Browse files
lwinmoepaingclaude
andcommitted
📝 docs: add CLAUDE.md and update .gitignore for claude code files
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 6361779 commit 05ebe9b

3 files changed

Lines changed: 82 additions & 1 deletion

File tree

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ next-env.d.ts
3838
# contentlayer
3939
.contentlayer
4040

41+
# claude code
42+
.claude/
43+
.agents/
44+
skills-lock.json
45+
4146
# Dont need package locks
4247
yarn.lock
4348
package-lock.json

.husky/commit-msg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/usr/bin/env sh
22
. "$(dirname -- "$0")/_/husky.sh"
33

4-
cat $1 | commitlint
4+
npx commitlint < $1

CLAUDE.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# CLAUDE.md
2+
3+
## Project Overview
4+
5+
Myanmar Software Engineers (MMSWE) — a community platform showcasing Myanmar software engineers with profile listings and blog functionality. Static site deployed to GitHub Pages at mmswe.com.
6+
7+
## Tech Stack
8+
9+
- **Framework**: Next.js 13.5.4 (App Router, TypeScript, static export)
10+
- **Package Manager**: Bun (primary)
11+
- **Styling**: Tailwind CSS + DaisyUI + Sass
12+
- **Content**: Contentlayer with MDX (profiles and blogs)
13+
- **Animation**: Framer Motion, Three.js / React Three Fiber
14+
- **Path alias**: `@/*``./src/*`
15+
16+
## Commands
17+
18+
```bash
19+
bun install # Install dependencies
20+
bun dev # Dev server
21+
bun run build # Build static site (output: ./out)
22+
bun run serve # Serve static build locally
23+
bun run lint # ESLint
24+
bun run content:build # Build contentlayer content
25+
bun run commit # Interactive gitmoji commit helper
26+
```
27+
28+
## Project Structure
29+
30+
```
31+
src/
32+
app/ # Next.js App Router pages (blog, profile, contact-us)
33+
components/ # Reusable React components (Animate, Common, Profile, Ui)
34+
config/ # App configuration
35+
data/ # Static data (animation variants, icon list)
36+
hooks/ # Custom React hooks
37+
styles/ # Global styles (SCSS)
38+
utils/ # Utilities (profileHelper.ts for filtering/search)
39+
content/
40+
profile/ # Developer profiles (.mdx files)
41+
blog/ # Blog posts (.mdx files)
42+
```
43+
44+
## Content Schemas
45+
46+
**Profile** (`content/profile/*.mdx`):
47+
```yaml
48+
name: string (required)
49+
description: string
50+
tags: string[] # Technology tags
51+
image: string # GitHub avatar URL
52+
```
53+
54+
**Blog** (`content/blog/*.mdx`):
55+
```yaml
56+
title: string (required)
57+
description: string
58+
date: date (required)
59+
published: boolean (default: true)
60+
```
61+
62+
## Commit Convention
63+
64+
Uses **gitmoji** commits enforced by commitlint + Husky. Format: `:emoji: type(scope): message`
65+
66+
Key types:
67+
- `:fire: build(profile): add <name> profile` — new profiles
68+
- `:beers: build(blog): add <name> blog` — new blogs
69+
- `:sparkles: feat: <description>` — new features
70+
- `:bug: fix: <description>` — bug fixes
71+
- `:lipstick: style: <description>` — UI/UX changes
72+
- `:recycle: refactor: <description>` — refactoring
73+
74+
## CI/CD
75+
76+
GitHub Actions (`.github/workflows/build.yml`): on push/PR to `main`, installs with Bun, builds, deploys to GitHub Pages.

0 commit comments

Comments
 (0)