---

TODO: Project Name (AOSSIE Webpage Starter)

TODO is a ... TODO: Project Description.

A high-performance, developer-friendly webpage starter kit built on Next.js 16 (App Router), React 19, Tailwind CSS v4, and pre-configured for Internationalization (i18n) and Localization (l10n) using next-intl.

This starter is designed for organizations looking to kickstart their web presence with a fully accessible, multi-lingual, and responsive architecture out-of-the-box.

---

🚀 Features

TODO: List your main features here:

• Feature 1: Description
• Feature 2: Description
• Feature 3: Description
• Feature 4: Description

---

💻 Tech Stack

TODO: Update based on your project

---

📋 Project Maturity & TODO Checklist

In the checklist below, mark the items that have been completed for your project:

• The project has a logo (brand/logo.svg).
• The project has a favicon (brand/favicon.ico).
• The web frontend:
  • Has proper title and metadata.
  • Has proper open graph metadata, to ensure that it is shown well when shared in social media.
  • Has a footer and header with AOSSIE logos and social handles.
  • Is client-side rendered ("use client" configured for pages).
  • Is deployed to GitHub Pages via a GitHub Workflow (.github/workflows/nextjs.yml).
  • Has automated CI build and lint validation (.github/workflows/ci.yml).
  • Has CodeRabbit automated AI code review (.coderabbit.yml).
  • Has open-source legal compliance (DCO.md, COPYRIGHT.md, Contributors.md).

---

🚀 Key Features

• Next.js 16 & React 19: Utilizing the latest Server Components, Client Actions, and async routing paradigms.
• Tailwind CSS v4: Modern utility-first styling with native CSS variables and streamlined postcss integrations.
• Dual Theme System: Flash-free light, dark, and system preferred themes using next-themes and Tailwind CSS v4 custom variants.
• Robust i18n & l10n: Deeply integrated multi-language support:
  • Automatic locale detection based on browser preferences.
  • Subpath routing (e.g., /en, /hi) with clean as-needed URL prefixing.
  • Sleek, interactive language switcher client component.
  • Zero-bundle-size footprint for static translations using Server Components & Client useTranslations.
• Developer Experience: Strict TypeScript compilation and ES Lint setup.
• Application Control Compatibility: Configured with manual Webpack & Turbopack alias resolution to bypass restrictive execution environments blocking native binary compiles.
• Open-Source Governance & CI/CD: Integrated GitHub Actions workflows (ci.yml, nextjs.yml, label-merge-conflicts.yml), .coderabbit.yml, and DCO.md legal documentation.
• AI Agent Pairing Ready: Includes AGENTS.md and CLAUDE.md to guide AI development agents.

---

📂 Project Structure

Here is a breakdown of the key i18n directories and files:

├── .github/
│   └── workflows/          # GitHub Actions (CI, GitHub Pages deployment, merge conflict checks)
├── brand/
│   ├── logo.svg            # Vector logo
│   ├── favicon.ico         # Browser tab icon
│   └── Brand.md            # Official AOSSIE brand guidelines document
├── next.config.ts          # Alias-wrapped Next configuration
├── public/                 # Static assets, robots.txt, assetlinks.json, llms.txt
├── src/
│   ├── config/
│   │   └── languages.ts        # Central registry of supported languages & locales
│   ├── i18n/
│   │   ├── routing.ts          # Core i18n routing parameters (locales, defaults)
│   │   ├── request.ts          # Server-side translation dictionary loading configuration
│   │   └── navigation.ts       # Type-safe navigation helpers (Link, useRouter, etc.)
│   ├── messages/
│   │   ├── en.json             # English translation dictionary
│   │   └── hi.json             # Hindi translation dictionary
│   ├── app/
│   │   ├── sitemap.ts          # Dynamically generated localized sitemaps
│   │   └── [locale]/           # Localized route group
│   │       ├── layout.tsx      # Multi-lingual layout injecting client context & translations
│   │       ├── page.tsx        # Localized Landing Page ("use client")
│   │       ├── globals.css     # Global styles for the app segment
│   │       ├── error.tsx       # Localized Error Boundary page fallback
│   │       └── not-found.tsx   # Localized 404 page fallback
│   ├── components/
│   │   ├── LanguageSwitcher.tsx # Dropdown element to switch interface locales interactively
│   │   ├── ThemeToggle.tsx      # Multi-state theme switch with micro-animations
│   │   └── providers/
│   │       ├── theme-provider.tsx # Next-themes client wrapper component
│   │       └── lenis-provider.tsx # Lenis smooth scrolling provider wrapper
│   └── proxy.ts                # Next.js 16 Proxy Middleware for route and locale redirection
├── .coderabbit.yml         # Automated AI Code Review configuration
├── COPYRIGHT.md            # Copyright terms
├── Contributors.md         # Project contributors list
└── DCO.md                  # Developer Certificate of Origin

---

🛠️ Usage Guide

1. Adding a New Language

To add support for a new language (e.g., French - fr):

1. Register the language: Open src/config/languages.ts and add your new language to the languages array:

   export const languages: Language[] = [
     { code: 'en', name: 'English', localName: 'English' },
     { code: 'hi', name: 'Hindi', localName: 'हिन्दी' },
     { code: 'fr', name: 'French', localName: 'Français' } // Add this line
   ];

2. Create the translation catalog: Under src/messages/, create a new file named fr.json:

   {
     "Home": {
       "heading": "Bienvenue sur AOSSIE Webpage Starter"
     }
   }

3. That's it! Next.js and next-intl will automatically register the locale, add it to the routing tables, and handle redirection for visitors matching fr browser preferences.

---

2. Translating Text in Pages and Components

Server Components (Recommended for Static Content)

By default, server components can load translations statically without shipping translation JSONs to the client bundle:

import { useTranslations } from 'next-intl';

export default function Section() {
  const t = useTranslations('Home');
  return <h1>{t('heading')}</h1>;
}

Client Components

If your component uses React hooks (e.g., useState), define it with "use client" and import from next-intl:

"use client";

import { useTranslations } from 'next-intl';

export default function InteractiveButton() {
  const t = useTranslations('Home');
  return <button onClick={() => alert('Clicked!')}>{t('heading')}</button>;
}

---

3. Navigation Helpers

When navigating between routes, always use the locale-aware navigation helpers imported from src/i18n/navigation.ts instead of standard next/link or next/navigation:

import { Link } from '../../i18n/navigation';

// Will automatically resolve to /en/about or /hi/about based on active locale
<Link href="/about">About Us</Link>

For programmatic router navigation:

import { useRouter, usePathname } from '../../i18n/navigation';

const router = useRouter();
const pathname = usePathname();

// Switch active locale on current page
router.replace(pathname, { locale: 'hi' });

---

4. Theme Configuration & Dual Theme Support

The starter kit uses next-themes combined with Tailwind CSS v4's class-based custom variants to provide a responsive and flash-free theme experience.

Customizing Colors

Tailwind v4 is configured via CSS custom properties in src/app/[locale]/globals.css. To adjust the default light and dark theme background or text colors, edit the root variables:

:root {
  --background: #ffffff; /* Light theme background */
  --foreground: #121212; /* Light theme text */
}

.dark {
  --background: #0a0a0a; /* Dark theme background */
  --foreground: #f4f4f5; /* Dark theme text */
}

Using Theme Classes

To create element styles that adapt automatically to the user's selected theme, use semantic utility tokens instead of inline dark: utilities:

<div className="bg-background-secondary text-foreground-primary border border-border-default">
  This card automatically transitions colors across light and dark themes.
</div>

---

5. Smooth Scrolling (Lenis)

The starter repository integrates the lenis library to provide smooth, high-performance inertial scrolling across all browsers.

Customizing Lenis Options

To configure scroll parameters (e.g., dampening velocity, custom scroll durations, or scroll directions), update the parameters passed to the ReactLenis component in lenis-provider.tsx:

<ReactLenis root options={{ lerp: 0.1, duration: 1.5, smoothWheel: true }}>
  {children}
</ReactLenis>

To access the active Lenis instance or bind custom scroll animations programmatically in your page components, use the useLenis hook:

import { useLenis } from 'lenis/react';

const lenis = useLenis(({ scroll, limit, velocity, direction }) => {
  // Bind your scroll logic or animation timelines here
});

---

⚡ Development and Deployment

Getting Started

Install the project dependencies:

npm install

Start the development server:

npm run dev

Open http://localhost:3000 to view it. The application will automatically detect your browser's language preferences and route you to /en or /hi (or fall back to the default language, English).

Building for Production

Compile and optimize the project:

npm run build

This compiles optimized static pages under the /[locale] path and checks all TypeScript configurations.

Running in Production

Start the optimized server:

npm run start

---

⚙️ Initial Project Setup Checklist

When bootstrapping a new project from this starter repository, update the following configurations to align with your project's branding, package naming, and hosting domains:

1. Domain Names & Sitemap URL

• Sitemap Generator (src/app/sitemap.ts): Replace the default fallback domain https://project.aossie.org with your project's production domain, or set the NEXT_PUBLIC_SITE_URL environment variable in your production hosting panel.
• Search Crawler Rules (public/robots.txt): Replace the sitemap URL domain https://project.aossie.org/sitemap.xml with your production URL.

2. Branding Guidelines & Assets

• Logo & Favicons (brand/): Replace logo.svg and favicon.ico with your organization's custom logos. Copy these updated assets to the public/assets/icons/ directory as well (public/assets/icons/aossie_logo.svg and public/assets/icons/favicon.ico).
• Brand Documentation (brand/Brand.md): Document your custom color hex codes, typography selections, and asset paths here to guide future developers and AI coding agents.

3. SEO Structured Data

• Schema.org JSON-LD (src/app/[locale]/page.tsx): Locate the jsonLd object inside the Home component. Replace the default publisher URLs and name fields with your specific project metadata.

4. Mobile & AI Platform Configurations

• Android App Links (public/.well-known/assetlinks.json): Change the package name org.aossie.starter and insert your Android application certificate SHA-256 fingerprint to handle incoming domain links on mobile.
• AI Agent Plugins (public/.well-known/ai-plugin.json): Update the host URLs, contact emails, and description text to describe your final website's features to AI agents.
• LLM Crawler Rules (public/llms.txt): Serves the root crawlers policy indicating allowing LLM bot indexing. Update if you wish to block specific AI search engines.

---

🤝 Contributing

We welcome contributions of all kinds! To contribute:

1. Fork the repository and create your feature branch (git checkout -b feature/AmazingFeature).
2. Commit your changes (git commit -m 'Add some AmazingFeature').
3. Ensure code quality:
   • npm run lint
   • npm run build
4. Push your branch (git push origin feature/AmazingFeature).
5. Open a Pull Request for review.

© 2025 AOSSIE. Released under the Apache 2.0 / Open Source License.