Skip to content

Commit 950ff65

Browse files
authored
Update README with development and publishing guidelines
Added development and publishing instructions for GitHub Pages, including branching model, local development steps, production build commands, and deployment details.
1 parent 2aaa0d2 commit 950ff65

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
11
# gts-web
22
GTS Website source code
3+
4+
## Development & Publishing (GitHub Pages)
5+
6+
This website is a Vite/React static site deployed to **GitHub Pages**.
7+
8+
### Branching model
9+
10+
- Make changes in a **feature branch** (e.g. `feature/my-change`)
11+
- Open a Pull Request into `main`
12+
- After review, **merge to `main`**
13+
- Every push/merge to `main` triggers the **GitHub Actions Pages deployment** automatically
14+
15+
### Local development
16+
17+
```bash
18+
npm ci
19+
npm run dev
20+
```
21+
22+
### Production build (local verification)
23+
24+
```bash
25+
npm run build
26+
npm run preview
27+
```
28+
29+
### Deployment
30+
31+
Deployment is automated via GitHub Actions:
32+
- On push to main, the workflow builds the site and publishes the dist/ folder to GitHub Pages.
33+
- The custom domain is globaltypesystem.org.

0 commit comments

Comments
 (0)