Installing from CLI

Fast-track local install for getting Strapi running on your computer.

• Step 1: Make sure requirements are met
• Step 2: Create a new project
• Step 3: Start the project

Step 1: Make sure requirements are met

Node.js

Strapi only requires Node.js (opens new window). Strapi only supports LTS versions of Node.js, the current recommended version to run Strapi is Node LTS v14. Other versions of of Node.js may not be compatible with the latest release of Strapi.

This is everything you need to run Strapi on your local environment.

Software	Minimum version	Recommended version
Node.js	12.x	14.x
npm	6.x	6.x

Yarn (optional)

You can also use yarn if you want here (opens new window) are the instructions to get started with it.

Databases

Strapi currently support the following databases.

Database	Minimum version
SQLite	3
PostgreSQL	10
MySQL	5.6
MariaDB	10.1
MongoDB	3.6

Step 2: Create a new project

To quickly create a blank project from scratch, run this command:

yarn create strapi-app my-project --quickstart

Alternatively, to use one of our starters (opens new window), run this command instead:

yarn create strapi-starter my-project <starter-url>

To quickly create a blank project from scratch, run this command:

npx create-strapi-app my-project --quickstart

Alternatively, to use one of our starters (opens new window), run this command instead:

npx create-strapi-starter my-project <starter-url>

TIP

If you want to use specific database, you don't have to use the --quickstart flag. The CLI will let you choose the database of your choice. The --quickstart flag sets the database to SQLite.

TIP

By default, create-strapi-app will generate an empty Strapi project. If you want an application that is pre-configured for a specific use case, see the Templates section.

TIP

When using a starter, the project can be created from a specific branch, for example with a url like this: https://github.com/strapi/strapi-starter-gatsby-blog/tree/<my-branch>.

WARNING

If you use a custom database, it has to be up and running before creating your Strapi project

Step 3: Start the project

To start your Strapi application you will have to run the following command in your application folder.

yarn develop

npm run develop

TIP

If you created your application using --quickstart flag, it will automatically run your application.