Getting Started

Installing the generator tool

The purpose of this tool is to generate a foundation for new projects. In order to produce these foundational files, you need to first install the tool:

npm install -g fsg

Scaffolding out the foundational files

Create a new directory for your project anywhere on your machine and cd into it:

mkdir insert-project-name-here && cd insert-project-name-here

Once inside, simply running the command fsg will produce the beginning files.

After you've generated the files, ensure the following commands are run in the project root:

npm install

Note for Linux users: if you get the error You need to install postgresql-server-dev-X.Y for building a server-side extension or libpq-dev for building a client-side application, then run sudo apt-get install libpq-dev and try npm install again.

gulp build

If you do not have gulp installed on your machine, install it using npm install -g gulp.

Postgres database

Finally, the generated project assumes a running postgres database on port 5432 (the default port).