Docs

Quick Start

The fastest way to start building a Sliprail extension is by using our official templates. These templates provide a pre-configured project structure, allowing you to focus on writing code instead of setting up build tools.

Prerequisites

Before you begin, ensure you have Node.js and npm installed on your system.

Using the Official Templates

The Sliprail team provides two official GitHub repository templates to help you get started quickly:

  1. Single Extension Template: sliprail-extension-template
  • Best for: Creating a repository that will contain only one extension.
  • How to use: Visit the template repository and click the "Use this template" button to create your own repository.
  1. Multi-Extension Bundle Template: sliprail-extension-bundle-template
  • Best for: Managing and developing multiple extensions within a single repository.
  • How to use: Similarly, use the "Use this template" feature to create your multi-extension project.

After cloning the template to your local machine, you'll have a fully functional extension project skeleton, ready for you to start developing.