88 lines
1.5 KiB
Markdown
88 lines
1.5 KiB
Markdown
## Getting Started
|
|
|
|
### Prerequisite
|
|
|
|
This project requires:
|
|
|
|
- Node.js version 22.13.1
|
|
- pnpm version 9.15.4
|
|
|
|
To install Node.js, visit [nodejs.org](https://nodejs.org/)
|
|
|
|
To install pnpm, run:
|
|
|
|
```bash
|
|
npm install -g pnpm@9.15.4
|
|
```
|
|
|
|
### Installation
|
|
|
|
Install the dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
### Development
|
|
|
|
Start the development server with HMR:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
Your application will be available at `http://localhost:5173`.
|
|
|
|
## Building for Production
|
|
|
|
Create a production build:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
## Deployment
|
|
|
|
### Docker Deployment
|
|
|
|
To build and run using Docker:
|
|
|
|
```bash
|
|
# Build the 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 `pnpm 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](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
|
|
|
|
---
|
|
|
|
Built with ❤️ using React Router.
|