Skip to content

Latest commit

 

History

History
134 lines (87 loc) · 2.03 KB

README.md

File metadata and controls

134 lines (87 loc) · 2.03 KB

Next.js Starter

This is a starter template for building Next.js applications with tRPC, Chakra UI, Turbo Repo, and Vitest.

Features

  • Next.js - React framework for building server-side rendered and static websites
  • tRPC - TypeScript based Remote Procedure Call (RPC) framework
  • Chakra UI - React component library for building accessible and customizable UIs
  • Turbo Repo - A tool for building and deploying serverless applications
  • Vitest - A fast and modern test runner for Jest

Installation

To use this starter template, first clone this repository using:

git clone https://github.com/meratusdev/nextjs-starter.git

After cloning, navigate to the project directory and install the dependencies using your package manager of choice:

cd nextjs-starter
yarn install

or

cd nextjs-starter
npm install

or

cd nextjs-starter
pnpm install

Getting Started

Once the dependencies are installed, you can start the development server using:

yarn dev

or

npm run dev

or

pnpm run dev

This will start the Next.js development server on http://localhost:3000.

Build

To build the application for production, run:

yarn build

or

npm run build

or

pnpm run build

Build with Turbo

You can build the application using Turbo by running:

yarn turbo build

or

npm turbo build

or

pnpm turbo build

For more information on using Turbo Repo, see the official documentation.

Testing

To run the test suite, use:

yarn test

or

npm run test

or

pnpm run test

This will run the tests using Vitest.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue.

License

This starter template is licensed under the MIT License.