Skip to content

Latest commit

 

History

History
123 lines (93 loc) · 3.57 KB

README.md

File metadata and controls

123 lines (93 loc) · 3.57 KB
Raw

Logo

Fastify-React Boilerplate

Simple starter kit which just works

🚀 Features

  • Fastify: High-performance backend framework with a plugin-based architecture
  • React 18: Latest version of React for building dynamic user interfaces
  • TypeScript: Strong typing for both frontend and backend
  • Vite: Next-generation frontend tooling for rapid development
  • Turbo: Efficient monorepo management and task running
  • tRPC: End-to-end typesafe APIs for seamless client-server communication
  • Ant Design: Comprehensive UI component library for React
  • Zustand: Lightweight state management for React
  • Orchid ORM: Lightweight ORM for PostgreSQL
  • zod: TypeScript-first schema validation

📦 Project Structure

fastify-react-starter/
├── apps/
│   ├── api/         # Fastify backend
│   └── pwa/         # React frontend
├── packages/        # Shared utilities and configurations
├── turbo.json       # Turbo configuration
└── package.json     # Root package.json

🛠️ Getting Started

  1. Clone the repository:

    git clone https://github.com/teziapp/fastify-react-starter.git
cd fastify-react-starter

  2. Install dependencies:

    pnpm i

  3. Set up environment variables:

    Create .env files at the root and in the api directory:

    Root .env:

    ENVIRONMENT='dev'
FRONTEND_URL=http://localhost:5173
VITE_BE_URL=http://localhost:3000

    api/.env:

    ENVIRONMENT='dev'
DB_URL=postgres://postgres:postgres@localhost:5432/boilerplate
DB_TEST_URL=postgres://postgres:postgres@localhost:5432/boilerplate
FRONTEND_URL=http://localhost:5173
VITE_BE_URL=http://localhost:3000
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
JWT_SECRET=your_jwt_secret

  4. Set up the database:

    pnpm run db create
pnpm run db migrate up

  5. Start the development server:

    pnpm run dev

  6. Build for production:

    pnpm run build

📜 Available Scripts

  • pnpm run dev: Start development servers for both backend and frontend
  • pnpm run build: Build both applications for production
  • pnpm run lint: Run ESLint across the project
  • pnpm run db: Manage database operations (create, migrate, etc.)

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments