KTU SA Website

Public-facing website for the Kaunas University of Technology Student Union (KTU SA). Built with Next.js, React, and Material UI, the site serves news, events, contacts, documents, and other information in Lithuanian and English.

Tech Stack

• Framework: Next.js 16 (App Router, Turbopack dev server)
• UI: React 19, MUI 7 (Material UI + Emotion)
• Language: TypeScript 5
• Internationalisation: next-intl – locales: lt, en
• Carousel: Embla Carousel
• Animations: Motion (Framer Motion)
• Linting: ESLint 9 (Next.js core-web-vitals + Prettier integration)
• Formatting: Prettier

Prerequisites

Tool	Version
Node.js	≥ 18
npm	≥ 9

Getting Started

# 1. Clone the repository
git clone <repository-url>
cd KTU-SA-Site/KTU-SA-WEB

# 2. Install dependencies
npm install

# 3. Create a .env.local file (see "Environment Variables" below)
cp .env.example .env.local

# 4. Start the development server (Turbopack)
npm run dev

The app will be available at http://localhost:3000.

Environment Variables

Create a .env.local file in the KTU-SA-WEB/ directory (or copy the provided example):

cp .env.example .env.local

Variable	Description	Default
KTU_SA_WEB_URL	Public base URL of the website	http://localhost:3000
KTU_SA_WEB_API_URL	Backend API base URL	https://localhost:5001/api

.env.example

# Public URL of the website (used for SEO, sitemap, robots.txt)
KTU_SA_WEB_URL=http://localhost:3000

# Backend API base URL (required – all data is fetched from here)
KTU_SA_WEB_API_URL=http://localhost:5000/api

Note: .env.local is git-ignored by default in Next.js. Never commit real credentials or production URLs.

Available Scripts

Command	Description
npm run dev	Start dev server with Turbopack
npm run build	Create a production build
npm start	Serve the production build
npm run lint	Run ESLint with auto-fix
npm run format	Format all files with Prettier
npm run format:check	Check formatting without writing changes
npm run validate-locales	Validate that locale JSON files are in sync

Project Structure

KTU-SA-WEB/
├── app/                  # Next.js App Router pages
│   ├── [lang]/           # Locale-scoped routes (lt / en)
│   │   ├── about-us/
│   │   ├── articles/
│   │   ├── contacts/
│   │   ├── documents/
│   │   ├── events/
│   │   ├── faq/
│   │   ├── fsa/
│   │   └── ...
│   ├── layout.tsx        # Root layout
│   ├── page.tsx          # Root page (locale redirect)
│   ├── robots.ts         # robots.txt generation
│   └── sitemap.ts        # Sitemap generation
├── components/           # Reusable UI components
├── constants/            # Static data & configuration
├── i18n/                 # Internationalisation setup (routing, request)
├── lib/                  # API clients, image loaders, SEO helpers
├── locales/              # Translation files (en.json, lt.json)
├── public/               # Static assets (images, icons, fonts)
├── styles/               # Global CSS
├── theme/                # MUI theme customisation (colours, styles)
└── utils/                # Utility functions (dates, strings)

Path Aliases

Configured in tsconfig.json:

Alias	Maps to
@api/*	./lib/api/*
@*	./*

Internationalisation

The site supports Lithuanian (lt) and English (en). Translation strings live in locales/lt.json and locales/en.json. Run npm run validate-locales to verify both files have matching keys.

Code Quality

• ESLint is configured with Next.js core-web-vitals rules plus additional error/warning rules for code quality (see eslint.config.mjs).
• Prettier handles formatting — run npm run format before committing.
• Keep linting and formatting checks passing: npm run lint && npm run format:check.