/niwi

Niwi Starter is a comprehensive, easy-to-use template for rapidly bootstrapping a Next.js application with essential features like authentication, blog management, email integration, database pre-seeding, and more. ๐ŸŽ‰

Primary LanguageTypeScriptMIT LicenseMIT

Niwi Starter ยท GitHub license PRs Welcome

# ๐Ÿš€ Niwi Starter

Niwi Starter is a comprehensive, easy-to-use template for rapidly bootstrapping a Next.js application with essential features like authentication, blog management, email integration, database pre-seeding, and more. ๐ŸŽ‰

## ๐ŸŽฏ Getting Started

To create a new project using Niwi Starter, run the following command:

```bash
npx create-niwi

This will automatically generate a Next.js project with the following features:

  • Authentication Flow: Built-in user authentication.
  • Blog Management System: A full-featured blog system similar to Medium.
  • Mail Integration: Pre-configured with Mailgun for sending emails.
  • Pre-seeded Database: Initial data for testing and development.
  • Database Management: Prisma configured with MongoDB.
  • Payment Integration: Stripe integration for handling payments.
  • SEO Helper Functions: Tools to optimize your site's SEO.

๐Ÿš€ Additional Custom Features

In addition to the default features, Niwi Starter offers additional systems that can be included during the setup process. When you run the npx create-niwi command, you will be prompted to select any additional features you want to include:

  • Niwi Music: A music management system similar to Spotify.
  • Niwi Library: A library management system for organizing books and other media.

๐Ÿ”ง Example Usage

To create a new project with Niwi Music or Niwi Library, follow these steps:

  1. Run the Niwi Starter command:
    npx create-niwi
  2. When prompted, select the additional features you want to include:
    Which major feature do you want to add?
    > niwi-music
    > niwi-library
    

๐Ÿ› ๏ธ Features

Authentication Flow

  • Secure user authentication out of the box.

Blog Management System

  • Create, edit, and manage blog posts with ease.
  • Similar functionality to Medium.

Mail Integration

  • Send emails using Mailgun.

Pre-seeded Database

  • Initial data for seamless development and testing.

Database Management

  • Prisma ORM configured with MongoDB.

Payment Integration

  • Accept and manage payments using Stripe.

SEO Helper Functions

  • Tools to optimize your site's search engine performance.

๐ŸŽฏ Additional Systems

  • ๐ŸŽต Niwi Music: Stream and manage music similar to Spotify.
  • ๐Ÿ“š Niwi Library: Manage books and other media efficiently.

๐Ÿค Contributing

We welcome contributions to Niwi Starter! Please see our CONTRIBUTING.md for details on how to get started. ๐Ÿค—

๐Ÿ“œ License

This project is licensed under the MIT License. See the LICENSE file for details. ๐Ÿ“


Start your project with Niwi Starter and build your application with ease! ๐Ÿš€

Welcome to Niwi Starter