GTWY Frontend

GTWY web frontend built with Next.js — fast UI, clean structure, and dev-friendly tooling.

Quick Start • Tech Stack • Structure • Env • Documentation • Scripts • Contributing

---

✨ What this repo contains

• Production-ready Next.js app (App Router)
• Reusable UI components + predictable folder structure
• Code quality: ESLint + Prettier
• Commit discipline: Husky + Commitlint

---

🚀 Quick Start

1) Clone

git clone https://github.com/Walkover-Web-Solution/gtwy-frontend.git
cd gtwy-frontend

2) Install

npm install

3) Configure env

Tip: Copy .env.example to .env.local. Never commit .env.local.

cp .env.example .env.local

4) Run

npm run dev

Open: http://localhost:3000

---

🧱 Tech Stack

Framework	Next.js (App Router), React
Styling	Tailwind CSS, Daisy UI
Quality	ESLint, Prettier

---

🗂️ Project Structure

Click to view

app/	Next.js routes/pages (App Router)
components/	Reusable UI components
store/	App state management
hooks/	React hooks
customHooks/	Custom hooks / app-specific hooks
utils/	Utilities/helpers
styles/	Global styles
public/	Static assets
wrapper/	Wrappers/layout helpers

---

🔐 Environment Variables

Use .env.local for local development.

Rule: Keep secrets in env files. Don’t hardcode them. Don’t commit them.

Example (.env.local):

NEXT_PUBLIC_PYTHON_SERVER_URL=
NEXT_PUBLIC_SERVER_URL=

Note: Any variable starting with NEXT_PUBLIC_ is exposed to the browser. Use it only for non-secret values.

---

📚 Documentation

• Architecture: docs/ARCHITECTURE.md
• AI Instructions: docs/AI_INSTRUCTIONS.md

---

⚙️ Scripts

npm run dev	Run development server
npm run build	Create production build
npm run start	Start production server
npm run lint	Lint the project

---

🧪 Quality & Git Rules

• Husky runs checks before commits/pushes
• Commitlint enforces clean commit messages (example: feat: add org members page)

---

🤝 Contributing

1. Create a branch: feat/your-change or fix/your-fix
2. Keep commits small and meaningful
3. Open a PR with:
   • what changed
   • why it changed
   • screenshots (for UI)

---

📄 License

Licensed under Apache-2.0.

_{Built for speed, structure, and clean developer experience.}