Welcome to the Next.js Starter Kit! This repository serves as a boilerplate for building a web applications using Next.js, NextAuth, Drizzle ORM, Turso, shadcn-ui and Tailwind, and more. Below you will find instructions for setting up the project, running various commands, and contributing to the repository.
Make sure you have Node.js installed on your machine. We recommend using the latest LTS version. Additionally, you should have pnpm installed globally:
npm install -g pnpmFirst, install the project dependencies:
pnpm installTo start the development server, run the following command:
pnpm devOpen http://localhost:3000 with your browser to see the result.
Builds the application for production. The output will be in the .next folder. Run this command to prepare your app for deployment:
pnpm buildStarts the development server with hot-reloading enabled. Use this during development to see your changes in real-time:
pnpm devThis project uses Drizzle ORM for database migrations and management. Here are the relevant database commands:
-
Generate Migrations: Automatically generates migration files based on your schema. Use this command after making changes to your schema: - these can be found db/migrations once generated
pnpm db:generate
-
Push Migrations: Applies the generated migrations to your database. Use this command to update your database schema:
pnpm db:push
-
View Database: Opens the Drizzle Studio for visualizing and interacting with your database schema:
pnpm db:view
Pull requests are welcome! If you have any ideas, improvements, or bug fixes, please feel free to contribute. Here's how you can get started:
- Fork the repository.
- Create a new branch (
git checkout -b feature/my-feature). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/my-feature). - Open a pull request.
This project is licensed under the MIT License.