Nodal

Quick Start

Guides

Community Resources

Reference

Edit on GitHub

Getting Started

Getting started with Nodal is easy.

  1. Download and install the newest Node 5.x version from nodejs.org
  2. Open terminal, and type npm install nodal -g. (If you get an error, run sudo npm install nodal -g or fix permissions permanently by following these directions
  3. Using your terminal, visit your projects folder. Perhaps with cd ~.
  4. Run nodal new.
  5. Follow the on screen instructions, enter your new project directory and type nodal s.

That's it! Your Nodal webserver is up and running.

Quick Start Without npm #

If you're not ready to use npm yet, you can download the starter kit which includes a prebuilt local installation of Nodal and an example Nodal API server instatweet-api.

Download Starter Kit 0.9.1

Next Steps #

Check out the tutorial and the other examples in the starter kit's examples directory to learn more.

We also have a wiki where the community contributes whatever they've found useful

Good luck, and welcome!

Next →