2025-02-22 12:03:32 +08:00
## Getting Started
2025-01-30 14:24:13 +08:00
2025-02-22 12:03:32 +08:00
### Prerequisite
2025-01-30 14:24:13 +08:00
2025-02-22 12:03:32 +08:00
This project requires:
2025-01-30 14:24:13 +08:00
2025-02-22 12:03:32 +08:00
- Node.js version 22.13.1
- pnpm version 9.15.4
2025-01-30 14:24:13 +08:00
2025-02-22 12:03:32 +08:00
To install Node.js, visit [nodejs.org ](https://nodejs.org/ )
2025-01-30 14:24:13 +08:00
2025-02-22 12:03:32 +08:00
To install pnpm, run:
```bash
npm install -g pnpm@9 .15.4
```
2025-01-30 14:24:13 +08:00
### Installation
Install the dependencies:
```bash
2025-02-22 12:03:32 +08:00
pnpm install
2025-01-30 14:24:13 +08:00
```
### Development
Start the development server with HMR:
```bash
2025-02-22 12:03:32 +08:00
pnpm dev
2025-01-30 14:24:13 +08:00
```
Your application will be available at `http://localhost:5173` .
## Building for Production
Create a production build:
```bash
2025-02-22 12:03:32 +08:00
pnpm build
2025-01-30 14:24:13 +08:00
```
## Deployment
### Docker Deployment
To build and run using Docker:
```bash
2025-02-22 12:03:32 +08:00
# Build the docker
2025-01-30 14:24:13 +08:00
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.
2025-02-22 12:03:32 +08:00
Make sure to deploy the output of `pnpm build`
2025-01-30 14:24:13 +08:00
```
├── 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 ](https://tailwindcss.com/ ) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
---
Built with ❤️ using React Router.