Skip to content

README.md

Latest commit

 

History

History
94 lines (65 loc) · 2.34 KB

README.md

File metadata and controls

94 lines (65 loc) · 2.34 KB

Cristian Starter Kit

A modern, full-stack monorepo starter kit built with Turborepo. This project provides a foundation for building scalable web applications with a clear separation between frontend and backend services.

Project Structure

This monorepo is organized into the following structure:

Apps

  • frontend/: A Next.js application for the frontend
  • backend/: A Node.js application for the backend

Packages

  • eslint-config/: Shared ESLint configuration for consistent code style across the monorepo

Tech Stack

  • Build System: Turborepo for efficient monorepo management
  • Frontend: Next.js for the web application
  • Backend: Node.js for the server
  • Language: TypeScript for type-safe code
  • Code Quality:

Getting Started

Prerequisites

  • Node.js >= 18
  • npm >= 10.2.4

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/cristian-starter-kit.git
cd cristian-starter-kit
  1. Install dependencies:
npm install

Development

To start the development servers for all applications:

npm run dev

This will start both the frontend and backend applications in development mode.

Building

To build all applications:

npm run build

Other Commands

  • npm run lint: Run ESLint across all packages and apps
  • npm run format: Format code using Prettier
  • npm run check-types: Run TypeScript type checking

Remote Caching

This project supports Turborepo's Remote Caching feature, which can significantly speed up builds across your team and CI/CD pipelines. To enable it:

  1. Create a Vercel account if you don't have one
  2. Authenticate with Vercel:
npx turbo login
  1. Link your repository to Remote Cache:
npx turbo link

Contributing

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

License

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