From 9af222defa18d75dd2fd9099d3fdc8b4105f2678 Mon Sep 17 00:00:00 2001 From: Amr Gaber Date: Sun, 12 Apr 2026 13:27:34 -0500 Subject: [PATCH] docs: add table of contents to README Closes #19 --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index b8ebb81..d88f4b3 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,36 @@ A production-ready React starter template built with Vite, TanStack Router, TanS Designed to pair with [api-template](https://github.com/ag-tech-group/api-template) (FastAPI backend with cookie JWT auth and refresh tokens), but can work with any backend. +## Table of Contents + +- [Tech Stack](#tech-stack) +- [Features](#features) +- [Getting Started](#getting-started) + - [Prerequisites](#prerequisites) + - [Installation](#installation) + - [Development](#development) + - [Build](#build) +- [Customizing for Your App](#customizing-for-your-app) +- [Authentication](#authentication) + - [How it works](#how-it-works) +- [Theming](#theming) +- [Error Handling](#error-handling) +- [API Client Generation](#api-client-generation) + - [Generate API Client](#generate-api-client) + - [Configuration](#configuration) + - [Usage](#usage) +- [Testing](#testing) + - [Test Utilities](#test-utilities) +- [Project Structure](#project-structure) +- [Adding Components](#adding-components) +- [Logging, Analytics & Feature Flags](#logging-analytics--feature-flags) + - [Logger](#logger) + - [Analytics](#analytics) + - [Feature Flags](#feature-flags) +- [Environment Variables](#environment-variables) +- [License](#license) +- [Acknowledgments](#acknowledgments) + ## Tech Stack - **React 19** - UI library