Getting Started

This is a guide to starting a new project with Commonplace.

Getting Commonplace

Simply run the following command:

npm install -g commonplace

First steps

The first thing you'll want to do is create the project and run the installer.

cd /opt
mkdir myproj
cd myproj
# Initialize a git repo
git init
# Run the Commonplace installer
commonplace install

Configuration

To make the project run, you'll need to provide configuration. A src/media/js/settings.js file should have been created for you. In that file, you'll find a number of parameters that will need to be configured to your project.

Testing it out

At this point, you should be able to run damper in the project root to start a simple server. This will be accessible at http://localhost:8675/. You can read more about that in the Damper article.

If you navigate to http://localhost:8675/tests, you should be able to run the project's unit tests.

Next Steps

Next, you'll want to do the following:

• Define some views
• Set up API routes
• Start building pages