This section will explain you how to set up a new instance of muffin on your own device. From there, you can then start building your own site even and deploying it.

Requirements

As the first step, you need to make sure that the latest version of those things is installed on your computer:

• Node.js
• MongoDB
• muffin’s CLI

After installing all of the above dependencies, please make sure that your npm permissions are fixed.

Usage

If you want to set up a new site with muffin, please firstly make sure that your database is running. This is required because the site generator will directly insert some sample data into it.

On your local machine, the easiest way to start MongoDB is by running the following command:

mongod

After that, simply use our neat command line interface (which you’ve already installed previously) to generate a new boilerplate within the current directory:

muffin new

You’ll then be asked to enter a few details about your site and the database connection. After you’ve answered all questions, your new site will be prepared.

As soon as the setup is finished, use the following command to run a server for your site:

npm start

To be continued…

That was all! 📢🐢

Now we suggest you to learn more about how muffin’s API works and what you can do with it. That’s the essential knowledge for building sites with it.