Getting Started with NextUpKit

Welcome to NextUpKit! This guide will walk you through setting up your project and getting your first feature live.

Prerequisites

Before you begin, make sure you have:

• Node.js 20 or later installed
• A MongoDB database (local or cloud)
• A code editor like VS Code

Quick Start

Clone the repository and install the dependencies:

git clone https://github.com/your-username/nextupkit.git
cd nextupkit
npm install

Copy the environment variables file and fill in your values:

cp .env.example .env.local

Start the development server:

npm run dev

Your app should now be running at http://localhost:3000.

Project Structure

Here's a quick overview of the key directories:

Directory	Purpose
src/app	Next.js App Router pages and API routes
src/components	Reusable React components
src/lib	Utility functions and configurations
src/models	Mongoose database models
content/blog	MDX blog posts (like this one!)

What's Included

NextUpKit comes with everything you need to build a SaaS product:

1. Authentication — Email magic links + OAuth (Google, GitHub, Facebook)
2. Payments — Lemon Squeezy integration for subscriptions
3. Database — MongoDB with Mongoose ODM
4. Blog — MDX-powered blog (you're reading it now!)
5. UI Components — shadcn/ui with dark mode support

Adding a Blog Post

To add a new blog post, simply create a new .mdx file in the content/blog/ directory:

---
title: "My New Post"
description: "A brief description of the post."
date: "2025-01-20"
author: "Your Name"
tags:
  - example
---

Your markdown content goes here. You can use **bold**, *italic*,
code blocks, tables, and all standard markdown features.

The post will automatically appear on the /blog page, sorted by date.

Next Steps

• Configure your authentication providers in .env.local
• Set up your Lemon Squeezy store for payments
• Customize the landing page components
• Start building your product!

Happy building!