Skip to main content

Welcome!

This is Jackfish - a highly customisable CMS built for publishing platforms.

Powered by Node, Backbone, Pug (Jade), and MongoDB.

Getting Started​

Get started by creating a new CMS.

What you'll need​

  • Node.js version 14 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
  • MongoDB version 3.6 - 4.x
MongoDB v5

Currently, v5 of MongoDB is not tested or officially supported!

Generate a new CMS​

yarn init jackfish@latest my-cms

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Jackfish.

Follow the interactive generator to get the project started.

Start your CMS​

Run the development servers:

cd my-cms
yarn run dev

The cd command changes the directory you're working with. In order to work with your newly created Jackfish CMS, you'll need to navigate the terminal there.

The yarn run dev command builds your cms and serves it through a development server, ready for you to view at http://localhost:3000/.