Getting Started
Prerequisite
This project requires:
- Node.js version 22.13.1
- pnpm version 9.15.4
To install Node.js, visit nodejs.org
To install pnpm, run:
npm install -g pnpm@9.15.4
Setup Environtment
You'll need to set the following environment variables to connect to your backend:
VITE_API_URL: The domain or IP address of your backend server (e.g., http://localhost:3000, http://127.0.0.1:8080, or the actual backend server URL).
VITE_SALT_KEY: The salt key that used for hashing the secret variable.
Installation
Install the dependencies:
pnpm install
Development
Start the development server with HMR:
pnpm dev
Your application will be available at http://localhost:5173.
Building for Production
Create a production build:
pnpm build
Deployment
Docker Deployment
To build and run using Docker:
# 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 already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
Built with ❤️ using React Router.