93 lines
1.7 KiB
Markdown
Raw Normal View History

2020-02-10 14:21:18 +01:00
# Installing from CLI
Fast-track local install for getting Strapi running on your computer.
[[toc]]
## Step 1: Make sure requirements are met
#### Node.js
Strapi only requires [Node.js](https://nodejs.org). The current recommended version to run strapi is Node v12 (current LTS).
This is everything you need to run Strapi on your local environment.
2020-02-10 14:21:18 +01:00
| Software | Minimum version |
| -------- | --------------- |
2020-02-10 14:21:18 +01:00
| Node.js | 12.x |
| npm | 6.x |
#### Yarn (optional)
You can also use **yarn** if you want [here](https://yarnpkg.com/en/docs/getting-started) are the instructions to get started with it.
#### Databases
Strapi currently support the following databases.
2020-02-10 14:21:18 +01:00
| Database | Minimum version |
| ---------- | --------------- |
2020-02-10 14:21:18 +01:00
| SQLite | 3 |
| PostgreSQL | 10 |
| MySQL | 5.6 |
| MariaDB | 10.1 |
| MongoDB | 3.6 |
## Step 2: Create a new project
:::: tabs
::: tab yarn
2020-02-10 14:21:18 +01:00
```bash
yarn create strapi-app my-project --quickstart
```
2020-02-10 14:21:18 +01:00
:::
::: tab npx
2020-02-10 14:21:18 +01:00
```bash
npx create-strapi-app my-project --quickstart
```
2020-02-10 14:21:18 +01:00
:::
::::
::: 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.
:::
::: warning
If you use a custom database, this one 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.
:::: tabs
::: tab yarn
2020-02-10 14:21:18 +01:00
```bash
yarn develop
```
2020-02-10 14:21:18 +01:00
:::
::: tab npm
2020-02-10 14:21:18 +01:00
```bash
npm run develop
```
2020-02-10 14:21:18 +01:00
:::
::::
::: tip
If you created your application using `--quickstart` flag, it will automatically run your application.
:::