AOSSIE's Website

This repository contains the assets required to build AOSSIE's Website. We're glad that you want to contribute! Contributions to the project are very much welcomed! Please reach out with ideas for new content or issues with existing content!

The website is built on Next.js 16 (App Router), React 19, Tailwind CSS v4, and pre-configured for Internationalization (i18n) and Localization (l10n) using next-intl.

🚀 Features

Multi-lingual Support (i18n): Deeply integrated multi-language support powered by next-intl.
Dual Theme System: Light, Dark, and System mode support with zero flash on load.
Modern Responsive Design: Crafted with Tailwind CSS v4 and smooth scrolling via Lenis.
High Performance: Built with Next.js 16 App Router and React 19 for speed and SEO.

💻 Tech Stack

Framework: Next.js 16.2.11 (App Router, Turbopack)
Library: React 19
Styling: Tailwind CSS v4 & PostCSS
Internationalization: next-intl
Theme Manager: next-themes

📋 Project Maturity & TODO Checklist

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

🚀 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

├── .github/workflows/          # CI, GitHub Pages deployment, merge-conflict checks
├── next.config.ts              # Next.js config (static export, next-intl plugin)
├── scripts/
│   └── update-repo-stats.mjs   # Refreshes GitHub stars / activity used to rank projects
├── public/
│   ├── llms.txt, robots.txt, .well-known/
│   └── brand/
│       ├── Brand.md            # Official AOSSIE brand guidelines
│       ├── icons/              # AOSSIE, partner and social icons
│       ├── project_svgs/       # Official project logos (from AOSSIE-Org/Info)
│       └── project_logos/      # Project logos collected from each project's repository
└── src/
    ├── app/
    │   ├── sitemap.ts          # Localized sitemap for every page
    │   └── [locale]/           # Localized routes
    │       ├── layout.tsx      # Fonts, theme, smooth scrolling, translations
    │       ├── page.tsx        # Home: hero, projects, partners, impact numbers
    │       ├── about/          # About page
    │       ├── projects/       # Projects catalogue (search, filters, sorting, grouping)
    │       ├── programs/       # GSoC, internships, Australian Winter of Code
    │       └── globals.css     # Theme tokens and global styles
    ├── components/             # Navbar, Footer, Hero, Stats, Sponsors, ProjectLogo, ...
    ├── i18n/                   # Routing, request config, navigation helpers, metadata
    ├── lib/
    │   ├── projectsData.ts     # Every project: text, logo, topics, themes, repos, links
    │   ├── projectTranslations/ # Project descriptions per locale (hi.ts, zh.ts, ...)
    │   ├── repoStats.ts        # Generated GitHub stats snapshot (do not edit by hand)
    │   └── links.ts            # Shared external links
    ├── messages/               # UI translations, one JSON file per locale (en.json is the source)
    └── __tests__/              # Vitest suites, including content checks

🗂️ Managing Projects & Content

All projects displayed on the website are managed through structured data files. Modifying projects involves a few coordinated files to ensure full translations, asset linkage, and GitHub statistics.

1. Adding a New Project

Add the project metadata in src/lib/projectsData.ts: Add a new entry to the PROJECTS_DATA array:

{
  slug: "my-project",
  name: "My Project",
  description: "One or two sentences summarizing the project for cards.",
  about: "Optional longer overview shown in the Details modal.",
  logo: "/brand/project_logos/my_project_logo.png", // or project_svgs/
  logoInvertOnDark: false, // Set true if single-dark logo needs inverting in dark mode
  topics: ["Artificial Intelligence"], // "Blockchain" | "Artificial Intelligence" | "Mobile"
  themes: ["Education"], // "Communication" | "Education" | "Finance" | "Sustainability" | "Infrastructure"
  repositories: [
    { fullName: "AOSSIE-Org/My-Project", language: "TypeScript" },
  ],
  discordUrl: aossieChannel("DISCORD_CHANNEL_ID"), // or AOSSIE_DISCORD_INVITE
  websiteUrl: "https://myproject.aossie.org", // optional
}

Add the logo asset (Optional):
- Place image or SVG in public/brand/project_logos/ or public/brand/project_svgs/.
- Projects without a logo automatically display a fallback monogram.
Add translations in src/lib/projectTranslations/:
- Add the matching slug entry to every locale file (hi.ts, zh.ts, es.ts, ...) with translated description (and about, if provided in English).
Fetch GitHub statistics:
- Run npm run update:stats (set GITHUB_TOKEN environment variable if needed to avoid API rate limits) to automatically update src/lib/repoStats.ts with star counts and commit activity.
Verify with tests:
- Run npm test to validate that all required fields, translations, and repository stats pass CI checks.

2. Changing / Updating an Existing Project

Copy or Links: Update the relevant fields (name, description, about, discordUrl, websiteUrl, topics, themes) in src/lib/projectsData.ts.
Translations: If you updated description or about, make sure to update the corresponding translations in every file under src/lib/projectTranslations/.
Repositories: If you added or changed repositories, run npm run update:stats to refresh src/lib/repoStats.ts.
Run validation: Execute npm test to ensure all consistency checks pass.

3. Archiving vs. Removing a Project

Archiving a project (Recommended for inactive/historical projects):
- Set archived: true on the project entry in src/lib/projectsData.ts.
- The project will remain catalogued with an Archived badge.
Removing a project completely:
1. Delete the project entry from PROJECTS_DATA in src/lib/projectsData.ts.
2. Remove its translated entries from every file under src/lib/projectTranslations/.
3. (Optional) Remove unused logo assets from public/brand/project_logos/ or public/brand/project_svgs/.
4. Run npm run update:stats to prune repository stats from src/lib/repoStats.ts.
5. Run npm test to verify no broken references remain.

Writing Copy Guidelines

Every user-facing UI string goes in src/messages/*.json in all supported locales.
Keep sentences plain and concise; avoid em dashes — (content tests enforce this rule).

🛠️ Usage Guide

1. Adding a New Language

The site currently supports English, Simplified Chinese, Hindi, Spanish, French, Arabic, Bengali, Portuguese, Russian, Urdu, Swahili, Hausa and te reo Māori. To add another language (e.g., Japanese - ja):

Register the language: Add it to the languages array in src/config/languages.ts, including its text direction and Open Graph locale:
```
{ code: 'ja', name: 'Japanese', localName: '日本語', dir: 'ltr', ogLocale: 'ja_JP' },
```
Create the translation catalog: Copy src/messages/en.json to src/messages/ja.json, translate every value, and register it in src/i18n/messages.ts. Keep ICU placeholders such as {count} and {count, plural, ...} intact.
Translate project text: Create src/lib/projectTranslations/ja.ts (same shape as hi.ts) and register it in src/lib/projectTranslations/index.ts.
Check the font: Latin, Cyrillic, Devanagari, Bengali and Arabic script are covered by the fonts in src/app/[locale]/layout.tsx; Chinese uses the visitor's system fonts. Add a Noto font there if the new script needs one.
Run npm test. The content tests check that every locale has the same keys and placeholders as English and a translation for every project.

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 the matching locale, such as /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. Project Identity & Header Details

Project Title & Logo (README.md): Update the main project header logo (public/brand/icons/aossie_logo.svg), title <h1>AOSSIE's Website</h1>, project description, feature list, and tech stack.
AI Agent Context (AGENTS.md): Update directives and rules for AI coding agents.
LLM Manifest (public/llms.txt): Update the root LLM crawler policy.
Community & Social Links (Contributors.md): Update Discord and community links.

2. Domain Names & Search Engine Crawlers

Sitemap Generator (src/app/sitemap.ts): Set the default fallback domain https://aossie.org or set the NEXT_PUBLIC_SITE_URL environment variable in your production hosting panel.
Search Crawler Rules (public/robots.txt): Point to your production sitemap URL (https://aossie.org/sitemap.xml).

3. Branding Guidelines & Assets

Logo & Favicons (public/brand/icons/): Maintain official organization logos (aossie_logo.svg and favicon.ico).
Brand Documentation (public/brand/Brand.md): Document custom color hex codes, typography selections, and asset paths to guide developers and AI coding agents.

4. SEO & i18n Localization Metadata

Schema.org JSON-LD (src/app/[locale]/page.tsx): Locate the jsonLd object inside the Home component and update publisher.name, publisher.url, and publisher.logo.
Translation Catalogs (src/messages/): Update the heading, metaTitle, and metaDescription keys with localized titles and descriptions.

5. Mobile & AI Platform Configurations

Android App Links (public/.well-known/assetlinks.json): Configure package name and Android application certificate SHA-256 fingerprint if applicable.
AI Agent Plugins (public/.well-known/ai-plugin.json): Update host URLs, contact emails, and description text to describe website features to AI agents.
LLM Crawler Rules (public/llms.txt): Serves the root crawlers policy indicating allowed LLM bot indexing.

🚀 Getting Started

To contribute to this repository you will need to:

Fork this repository
Push changes to a new branch in your fork
Create a pull request from that branch to the main branch of this repository

Note

Forking only needs to be done once, after which you can push changes to your fork.

💻 Running the website Locally

In order to run the site locally:

Fork the website and clone that fork on your system:

git clone https://github.com/<YOUR_USERNAME>/website.git

Open a terminal window and change the directory to the cloned repository:
```
cd website
```
In the root directory, install dependencies and start the development server:
```
npm install
npm run dev
```
The website will be active at http://localhost:3000.

🤝 Contributing

Contributions to the project are very much welcomed! Please reach out with ideas for new content or issues with existing content.

You can contribute by:

Raising any issues you find
Fixing issues by opening Pull Requests
Improving the website
Talking about AOSSIE

If you want to get in touch with us first before contributing, join our community:

Discord: AOSSIE Discord Channel

📄 License

This project is licensed under the MIT License.

Name		Name	Last commit message	Last commit date
.agents/skills/manage-project-translations		.agents/skills/manage-project-translations
.github/workflows		.github/workflows
audit		audit
brand		brand
i18n		i18n
public		public
scripts		scripts
src		src
.coderabbit.yaml		.coderabbit.yaml
.gitignore		.gitignore
AGENTS.md		AGENTS.md
BestPracticesChecklist.md		BestPracticesChecklist.md
CLAUDE.md		CLAUDE.md
CONTRIBUTING.md		CONTRIBUTING.md
COPYRIGHT.md		COPYRIGHT.md
DCO.md		DCO.md
MAINTAINERS.md		MAINTAINERS.md
README.md		README.md
eslint.config.mjs		eslint.config.mjs
next.config.ts		next.config.ts
package-lock.json		package-lock.json
package.json		package.json
postcss.config.mjs		postcss.config.mjs
tsconfig.json		tsconfig.json
vitest.config.ts		vitest.config.ts

Uh oh!

Latest commit

History

Folders and files

Repository files navigation