Documentation

To get started developing with Mahalo without waiting for a proper guide to arrive a good startare the following pages:

Requirements

The easiest way to get started with Mahalo is by starting from themahalo-seed package. This is a pre-configured starte-kitthat contains a shell for creating Mahalo applications.

Before you can start you have to be familiar with NPM the packagemanager of Node.js which has to be installed onyour machine for Mahalo to work.

Another dependency of mahalo-seed is Gruntwhich is responsible for running various tasks like starting thedevelopment server or building a deployable script file.

Once you have Node.js installed you can install Grunt globally with followingcommand in a terminal

npm install -g grunt-cli

Option A: Install using Git

This assumes that you are familiar with Git and have it running in your environment.Create a new folder on your local machine that will host yourapplication. Inside of that folder execute the following two commands

git initgit pull https://github.com/mahalo/mahalo-seed.git

You now have an initialized Git repository in that folder and copied the filesfrom mahalo-seed to that folder.

Option B: Download the package

If you don't want to initialize a Git repository yet you can alsodownload the mahalo-seed package here.Just extract all files to a folder of your liking.

Running Mahalo

After you have the mahalo-seed package somewhere on your machine youcan install your applications dependencies with the following commandexecuted in your mahalo-seed folder

npm install

Congratulations! You can now start your Mahalo application in developmentmode by using the default Grunt task by typing the following command

grunt

This command will bundle your files and start the development sever listeningon port 8080 by default. Mahalo uses webpack as its modulebundler and webpack-dev-server to serve your application and automaticallyrefresh your browser when you make changes to your files.