Skip to content

Commit 249017a

Browse files
lwinmoepaingclaude
andcommitted
✨ feat: add "How to?" page, profile hero section, and update README
Add step-by-step visual guide at /how-to with 8-step vertical timeline, terminal-style code blocks, scroll-triggered animations, and profile editor/manual toggle. Update navbar with "How to" link. Add hero section to profile listing page. Rewrite README with comprehensive project docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 745069c commit 249017a

6 files changed

Lines changed: 1148 additions & 21 deletions

File tree

README.md

Lines changed: 212 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,228 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
<div align="center">
22

3-
## Getting Started
3+
<img src="public/seo/favicon-original.png" alt="MMSWE" width="80" />
44

5-
First, run the development server:
5+
# Myanmar Software Engineers
6+
7+
**A community platform connecting Myanmar's software engineering talent.**
8+
9+
[![Deploy](https://github.com/myanmar-software-engineers/myanmar-software-engineers.github.io/actions/workflows/build.yml/badge.svg)](https://github.com/myanmar-software-engineers/myanmar-software-engineers.github.io/actions/workflows/build.yml)
10+
[![License: MIT](https://img.shields.io/badge/License-MIT-a78bfa.svg)](LICENSE)
11+
[![Profiles](https://img.shields.io/badge/Engineers-116+-22d3ee.svg)](#profiles)
12+
[![Next.js](https://img.shields.io/badge/Next.js-16-000?logo=nextdotjs)](https://nextjs.org)
13+
[![Made with Bun](https://img.shields.io/badge/Bun-runtime-fbf0df?logo=bun)](https://bun.sh)
14+
15+
[**mmswe.com**](https://mmswe.com)
16+
17+
</div>
18+
19+
---
20+
21+
## About
22+
23+
MMSWE is an open-source platform where Myanmar software engineers can showcase their profiles, share technical articles, and connect with the community. Built as a static site deployed to GitHub Pages, it serves as a living directory of Myanmar's developer talent.
24+
25+
### Features
26+
27+
- **Developer Profiles** — 116+ engineer profiles with tech stacks, bios, and custom MDX pages
28+
- **Blog Platform** — Technical articles written by community members
29+
- **Profile Editor** — In-browser tool to create your profile MDX file without writing code
30+
- **Responsive Design** — Obsidian Prism dark theme with animated interactions
31+
32+
## Tech Stack
33+
34+
| Layer | Technology |
35+
|-------|-----------|
36+
| **Framework** | Next.js 16 (App Router, Static Export) |
37+
| **Language** | TypeScript, React 19 |
38+
| **Styling** | Tailwind CSS 3 + DaisyUI + Sass |
39+
| **Content** | Contentlayer2 with MDX |
40+
| **Animation** | Framer Motion, Three.js, React Three Fiber |
41+
| **Fonts** | Bricolage Grotesque, Plus Jakarta Sans, JetBrains Mono |
42+
| **Package Manager** | Bun |
43+
| **Deployment** | GitHub Pages via GitHub Actions |
44+
45+
## Quick Start
46+
47+
### Prerequisites
48+
49+
- [Bun](https://bun.sh) (recommended) or Node.js 18+
50+
- Git
51+
52+
### Setup
653

754
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
55+
# Clone the repository
56+
git clone https://github.com/myanmar-software-engineers/myanmar-software-engineers.github.io.git
57+
cd myanmar-software-engineers.github.io
58+
59+
# Install dependencies
60+
bun install
61+
62+
# Start development server
1463
bun dev
1564
```
1665

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
66+
Open [http://localhost:3000](http://localhost:3000) to view the site.
67+
68+
### Commands
69+
70+
```bash
71+
bun dev # Start dev server
72+
bun run build # Build static site (output: ./out)
73+
bun run serve # Serve static build locally
74+
bun run lint # Run ESLint
75+
bun run content:build # Rebuild contentlayer content
76+
bun run commit # Interactive gitmoji commit helper
77+
```
78+
79+
## Add Your Profile
80+
81+
There are two ways to add your profile to MMSWE:
82+
83+
### Option 1: Profile Editor (Recommended)
84+
85+
Visit [mmswe.com/profile/editor](https://mmswe.com/profile/editor) to create your profile using the visual editor. Fill in your details, preview in real-time, and download the `.mdx` file.
86+
87+
### Option 2: Manual Creation
88+
89+
1. **Fork** this repository
90+
2. Create a new file in `content/profile/` with your name (lowercase, no spaces):
91+
92+
```
93+
content/profile/yourname.mdx
94+
```
95+
96+
3. Add frontmatter and content:
97+
98+
```mdx
99+
---
100+
name: Your Name
101+
description: A short bio about yourself
102+
image: "https://avatars.githubusercontent.com/u/YOUR_ID?v=4"
103+
tags:
104+
- Frontend
105+
- React
106+
- TypeScript
107+
---
108+
109+
Write your profile content here using standard markdown.
110+
111+
## About Me
112+
113+
Hello! I'm a software engineer from Myanmar...
114+
```
115+
116+
4. **Submit a Pull Request** to the `main` branch
117+
118+
### Frontmatter Fields
119+
120+
| Field | Required | Description |
121+
|-------|----------|-------------|
122+
| `name` | Yes | Your display name |
123+
| `description` | No | Short bio (shown on profile card) |
124+
| `image` | No | Avatar URL (GitHub avatar recommended) |
125+
| `tags` | No | Technology/skill tags |
126+
127+
## Project Structure
128+
129+
```
130+
src/
131+
app/ # Next.js App Router pages
132+
blog/ # Blog listing & [slug] pages
133+
profile/ # Profile listing, [slug] & editor pages
134+
contact-us/ # Contact page
135+
components/ # React components
136+
MSE/ # Homepage sections (Hero, Join, Platform, etc.)
137+
Common/ # Shared UI (Navbar, Footer, Container, Tag, Mdx)
138+
Profile/ # Profile cards & lists
139+
ProfileEditor/ # Profile creation tool components
140+
Contributors/ # Custom contributor page widgets
141+
Ui/ # Base UI elements
142+
config/ # App configuration
143+
data/ # Static data & animation variants
144+
hooks/ # Custom React hooks
145+
styles/ # Global SCSS & Tailwind tokens
146+
utils/ # Utility functions
147+
content/
148+
profile/ # Developer profile MDX files (116+)
149+
blog/ # Blog post MDX files
150+
```
151+
152+
## Design System
153+
154+
MMSWE uses the **Obsidian Prism** theme — a dark interface with prismatic accent colors:
155+
156+
| Token | Color | Usage |
157+
|-------|-------|-------|
158+
| `obsidian` | `#09090b` | Base background |
159+
| `surface` | `#1a1a22` | Card backgrounds |
160+
| `prism-cyan` | `#22d3ee` | Primary accent |
161+
| `prism-violet` | `#a78bfa` | Secondary accent |
162+
| `prism-rose` | `#fb7185` | Tertiary accent |
163+
| `accent-gold` | `#fbbf24` | Highlight accent |
164+
165+
Typography uses **Bricolage Grotesque** for display, **Plus Jakarta Sans** for body, and **JetBrains Mono** for code.
166+
167+
## Contributing
168+
169+
We welcome contributions from all Myanmar software engineers!
170+
171+
### Ways to Contribute
172+
173+
- **Add your profile** — Follow the [profile guide](#add-your-profile) above
174+
- **Write a blog post** — Create an `.mdx` file in `content/blog/`
175+
- **Improve the platform** — Fix bugs, add features, improve UI
176+
- **Report issues** — Open an issue on GitHub
177+
178+
### Commit Convention
179+
180+
This project uses [gitmoji](https://gitmoji.dev/) commits enforced by commitlint + Husky:
181+
182+
```
183+
:sparkles: feat: add new feature
184+
:bug: fix: fix a bug
185+
:lipstick: style: update UI/UX
186+
:fire: build(profile): add yourname profile
187+
:beers: build(blog): add blog post title
188+
:recycle: refactor: refactor code
189+
:zap: perf: improve performance
190+
:memo: docs: update documentation
191+
```
192+
193+
Use `bun run commit` for an interactive commit helper.
194+
195+
### Development Guidelines
196+
197+
1. Fork and clone the repository
198+
2. Create a feature branch: `git checkout -b feat/your-feature`
199+
3. Make your changes and ensure `bun run build` passes
200+
4. Submit a pull request to `main`
201+
202+
## Deployment
203+
204+
The site automatically deploys to GitHub Pages on every push to `main` via GitHub Actions:
205+
206+
1. Installs dependencies with Bun
207+
2. Builds the static site (`next build` with `output: "export"`)
208+
3. Deploys the `./out` directory to GitHub Pages
18209

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
210+
## Community
20211

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
212+
- **Facebook Group**: [Myanmar Software Engineers](https://www.facebook.com/groups/myanmarsoftwareengineers)
213+
- **GitHub**: [myanmar-software-engineers](https://github.com/myanmar-software-engineers)
214+
- **Website**: [mmswe.com](https://mmswe.com)
22215

23-
## Learn More
216+
## License
24217

25-
To learn more about Next.js, take a look at the following resources:
218+
This project is licensed under the [MIT License](LICENSE).
26219

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
220+
Copyright (c) 2023 — [Lwin Moe Paing](https://github.com/lwinmoepaing)
29221

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
222+
---
31223

32-
## Deploy on Vercel
224+
<div align="center">
33225

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
226+
**Built with love by the Myanmar Software Engineers community.**
35227

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
228+
</div>

0 commit comments

Comments
 (0)