Welcome to React Router!

A modern, production-ready template for building full-stack React applications using React Router.

Features

• 🚀 Server-side rendering
• ⚡️ Hot Module Replacement (HMR)
• 📦 Asset bundling and optimization
• 🔄 Data loading and mutations
• 🔒 TypeScript by default
• 🎉 TailwindCSS for styling
• 📖 React Router docs

Project Structure

The project is structured with the application logic inside the app directory.

├── app/                 # Application source code
│   ├── components/      # UI components
│   ├── configs/         # Configs for the app
│   ├── hocs/            # Higher-order components
│   ├── hooks/           # Custom React hooks
│   ├── layouts/         # Layout components
│   ├── lib/             # Reusable libraries
│   ├── pages/           # Configs for the app
│   ├── pages/           # UI components for your pages
│   ├── routes/          # Route modules (loaders, actions, meta, etc.)
│   ├── styles/          # Global styles
│   ├── utils/           # Utility functions
│   ├── root.tsx         # The root layout component for the app
│   └── routes.ts        # The main route configuration file
├── public/              # Static assets (e.g., favicon.ico)
├── package.json
├── tsconfig.json
└── vite.config.ts

Getting Started

Installation

Install the dependencies:

npm install

Development

Start the development server with HMR:

npm run dev

Your application will be available at http://localhost:5173.

Building for Production

Create a production build:

npm run build

Deployment

Docker Deployment

To build and run using Docker:

docker build -t my-app .

# Run the container
docker run -p 3000:3000 my-app

The containerized application can be deployed to any platform that supports Docker, including:

• AWS ECS
• Google Cloud Run
• Azure Container Apps
• Digital Ocean App Platform
• Fly.io
• Railway

DIY Deployment

If you're familiar with deploying Node applications, the built-in app server is production-ready.

Make sure to deploy the output of npm run build

├── package.json
├── package-lock.json (or pnpm-lock.yaml, or bun.lockb)
├── build/
│   ├── client/    # Static assets
│   └── server/    # Server-side code

Styling

This template comes with Tailwind CSS already configured for a simple default starting experience. You can use whatever CSS framework you prefer.

---

Built with ❤️ using React Router.