Strapi Boilerplate

A Strapi application

Table of Contents

• Introduction
• Get Started
• Scripts
• Commitlint

Introduction

This is a boilerplate for a Strapi application. It includes a variety of configurations and scripts to facilitate development and production environments using Docker.

Get Started

Prerequisites

• Node.js (>=18.0.0 <=20.x.x)
• Yarn
• Docker
• Docker Compose

Installation

1. Clone the repository:

   git clone https://github.com/havascxistanbul/strapi-boilerplate.git
   cd strapi-boilerplate
   

2. Install dependencies:

   yarn install
   

3. For development:

   yarn docker-up:dev

4. Commitlint permission:

   chmod ug+x .husky/*

Scripts

The following scripts are available in this project:

• develop: Starts the Strapi application in development mode.
• start: Starts the Strapi application.
• build: Builds the Strapi application.
• strapi: Runs the Strapi CLI.
• lint: Runs ESLint.
• format: Formats the code using Prettier.
• docker-up:prod: Builds and starts the Docker containers in production mode.
• docker-up:dev: Builds and starts the Docker containers in development mode.
• docker-down:prod: Stops the Docker containers in production mode.
• docker-down:dev: Stops the Docker containers in development mode.
• prepare: Sets up Husky for Git hooks.

Commitlint

For commiting

https://commitlint.js.org/concepts/commit-conventions.html
https://www.conventionalcommits.org/en/v1.0.0/#summary