Getting Started

Starting with Statusfy is really easy, you just focus on writing your content and making use of the CLI for building and deploying your Website.


Statusfy requires Node.js >= 8.


Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

# change the working directory
cd existing_folder

# run the initialization command
npx statusfy init

# and install your local dependencies
npm install  # OR yarn install

It will be generated a basic structure for your project. In the package.json file will be available these commands for the development and deployment of your Status Page System:

  "scripts": {
    "dev": "statusfy dev",
    "build": "statusfy build",
    "start": "statusfy start",
    "generate": "statusfy generate",
    "new-incident": "statusfy new-incident"

You can create a new incident with:

npm run new-incident # OR yarn new-incident

and launch the development server with:

npm run dev # OR yarn dev

You can generate a Static Generated Website (pre-built HTML files) with:

npm run generate # OR yarn generate

The built files will be in ./dist, which can be configured via the --dest argument. More info in the Commands Guide.

or generate a Server Rendered Website with:

# generate static assets
npm run build # OR yarn build

# launch the server
npm run start # OR yarn start

By default, the Markdown source files will be in ./content, which can be configured via the dir field in ./config.js.

The built files can be deployed as Static Generated or Server Rendered Website. See Deployment Guide for guides on deploying to popular services.