Animal Family Web

A Next.js web application for managing animal families, enclosures, and tasks.

Backend Repository: animal-family-backend

Note: This is currently in Pre-Alpha. If you'd like to collaborate, please reach out! Find my contact info on whitcodes.dev/contact.

Prerequisites

• Node.js 22+ (see .nvmrc) and npm
• Backend API running (see Backend Repository)

Running Locally

1. Clone the repository:

git clone https://github.com/whitallee/animal-family-web.git
cd animal-family-web

2. Install dependencies:

npm install

3. Copy .env.example to .env.local:

cp .env.example .env.local

4. Start the development server:

npm run dev

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

Available Scripts

• npm run dev - Start development server with Turbopack
• npm run build - Build for production
• npm run start - Start production server
• npm run lint - Run ESLint (fails on any warning, not just errors)

npm install also sets up a pre-commit hook (via Husky) that runs ESLint on staged files — no separate setup step needed.

Tech Stack

• Framework: Next.js 15
• Language: TypeScript
• Styling: Tailwind CSS
• UI Components: shadcn/ui
• State Management: TanStack Query (React Query)

Development Status

See TODO.md for planned features, known bugs, and upcoming work.