Getting Started

Prerequisites

• Node.js 20 or higher
• npm 10 or higher

Setup

The easiest way to set up the project is to use the setup script:

npm run setup

Environment Setup

This project requires environment variables to be set up properly. Follow these steps:

Copy the example environment file:

cp .env.example .env

Development

Start the development server with HMR:

npm run dev

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

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.

---