Skip to content

Documentation

Manish Jha edited this page Sep 4, 2023 · 1 revision

Next-Prisma-Starter Wiki

Welcome to the Next-Prisma-Starter Wiki! This wiki is designed to provide detailed documentation and instructions for using the Next-Prisma-Starter boilerplate project. Whether you're new to the project or looking for specific information, you'll find it all here.

Table of Contents

  1. Getting Started
  2. Tech Stack
  3. Folder Structure
  4. Database Setup
  5. Running Migrations
  6. Seeding the Database
  7. Development Server
  8. Folder Structure
  9. Documentation
  10. License
  11. Contributions

1. Getting Started

Learn how to get started with the Next-Prisma-Starter project by following the steps outlined in the Getting Started section.

2. Tech Stack

Explore the technologies used in the Next-Prisma-Starter project, including Next.js, Prisma, Redux Toolkit, RTK Query, and Tailwind CSS. Find more details in the Tech Stack section.

3. Folder Structure

Understand the project's folder structure to keep your codebase clean and maintainable. Review the structure in the Folder Structure section.

4. Database Setup

Learn how to configure your database connection in the prisma/schema.prisma file. Discover the supported databases and configuration details in the Database Setup section.

5. Running Migrations

Follow instructions on applying database migrations to create the database schema. Find more details in the Running Migrations section.

6. Seeding the Database

Explore how to seed your database with dummy data and customize the seeding process. Learn more in the Seeding the Database section.

7. Development Server

Start the Next.js development server and begin building your project. Get detailed instructions in the Development Server section.

8. Documentation

For more detailed documentation on various features of Next-Prisma-Starter, including Redux Toolkit setup and API endpoints, visit the Documentation section.

9. License

Understand the licensing terms for the Next-Prisma-Starter project. Review the project's License for usage details.

10. Contributions

Contributions to Next-Prisma-Starter are welcome! Learn how to get involved and contribute by visiting the Contributions section.

11. Customization

Remember that this README is a template and should be customized to suit your specific project's needs. Feel free to adapt and expand the wiki as your project evolves.

Happy coding with Next-Prisma-Starter! 🚀