USM Week

USM Week is a web app that tracks the current academic period for Universiti Sains Malaysia, including the active week, semester progress, and a live countdown to the next milestone.

Stack

• Next.js 16 (App Router)
• React 19
• TypeScript
• Tailwind CSS 4
• Zod (calendar validation)
• Vitest (tests)

Getting Started

Prerequisites

• Node.js 20+
• npm

Run locally

npm install
npm run dev

Open http://localhost:3000.

Available Scripts

npm run dev        # Start development server
npm run build      # Build for production
npm run start      # Start production server
npm run lint       # Run ESLint
npm run test       # Run tests once
npm run test:watch # Run tests in watch mode

Calendar Data

Calendar data is stored in JSON files under data/calendars/.

Current file:

• data/calendars/usm-2025-2026.json

When updating calendar dates:

1. Edit the relevant JSON file.
2. Run npm run test to validate schema and calendar logic.
3. Start the app with npm run dev and verify the UI output.

Deployment

Standard production flow:

npm run build
npm run start