bookstairs/web/README.md

2.1 KiB
Raw Blame History

Welcome to React Router!

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

Open in StackBlitz

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

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

This template includes three Dockerfiles optimized for different package managers:

  • Dockerfile - for npm
  • Dockerfile.pnpm - for pnpm
  • Dockerfile.bun - for bun

To build and run using Docker:

# For npm
docker build -t my-app .

# For pnpm
docker build -f Dockerfile.pnpm -t my-app .

# For bun
docker build -f Dockerfile.bun -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.