Skip to main content

Installation Guide

MongoNext can be installed quickly using the create-mongonext-app CLI, or you can set up the template manually for development and customization.

Prerequisites​

  • Node.js (version 18.0 or above recommended)
  • npm (comes with Node.js)
  • A MongoDB Atlas account (free tier available)

To create a new project using MongoNext, run:

npx create-mongonext-app@latest my-app
cd my-app
npm install
npm run dev

This will scaffold a new project in the my-app directory with all dependencies and structure set up for you.

Manual Setup (For Contributors)​

If you want to clone and develop the template itself:

  1. Clone the repository 
    git clone https://github.com/yourusername/mongonext.git
    cd mongonext
  2. Install dependencies 
    npm install
    # or
    yarn install
  3. Set up environment variables
    • Create a .env.local file in the root directory and add: 
      MONGODB_URI=your-mongodb-atlas-connection-string
      NEXTAUTH_URL=http://localhost:3000
      NEXTAUTH_SECRET=your-random-secret
  4. Run the development server 
    npm run dev
    # or
    yarn dev

Visit http://localhost:3000 to view the app.

Continue to Environment Setup for details on configuring your environment and connecting to MongoDB Atlas.