Skip to content

Commit 07eced2

Browse files
committed
fix: update README section about running the project locally
1 parent 5e38176 commit 07eced2

2 files changed

Lines changed: 27 additions & 14 deletions

File tree

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,37 @@ Some requirements are:
1818

1919
## Run locally using sqlite3
2020

21-
The CMS relies on a database. The simplest is to use `Sqlite` for development.
21+
The CMS relies on a database. The simplest is to use **Sqlite** for development (it will be created automatically at `data/sqlite.db` when you start the app).
2222

23-
You actually don't need to do anything for this! If you run the project with `yarn dev`, it will automatically create a sqlite database in `data/sqlite.db`
23+
**Steps:**
2424

25-
```
26-
yarn dev
27-
```
25+
1. **Build the project** (required before running):
2826

29-
Then visit:
27+
```bash
28+
yarn build
29+
```
3030

31-
- **Admin**: <http://localhost:1337/admin>
31+
2. **Create a `.env` file** and set at least `APP_KEYS` (required for the app to start):
3232

33-
On its basic setup, you don't need to add any configuration parameter, however you might want to do so. You can do this by creating a `.env` file.
33+
```bash
34+
cp .env.example .env
35+
```
3436

35-
```bash
36-
# Create an ENV file from the example
37-
cp .env.example .env
38-
```
37+
Edit `.env` and set `APP_KEYS` to a comma-separated list of secret keys, for example:
38+
39+
```
40+
APP_KEYS="mySecretKey1,mySecretKey2"
41+
```
42+
43+
You can leave other values as in the example for local dev, or adjust them as needed (see [Strapi environment config](https://docs.strapi.io/dev-docs/configurations/environment)).
44+
45+
3. **Start the dev server:**
46+
47+
```bash
48+
yarn dev
49+
```
50+
51+
4. **Visit** <http://localhost:1337/admin> and create your local admin user.
3952

4053
## Dev locally using PostreSQL
4154

@@ -64,7 +77,7 @@ yarn dev
6477

6578
# 👷‍♀️ Build
6679

67-
Before running the server for the first time, you need to build it:
80+
Before running the server for the first time, you need to build it (see [Run locally using sqlite3](#run-locally-using-sqlite3) for the full setup). To build:
6881

6982
```bash
7083
yarn build

src/extensions/documentation/documentation/1.0.0/full_documentation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"name": "Apache 2.0",
1515
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
1616
},
17-
"x-generation-date": "2026-02-24T17:11:04.426Z"
17+
"x-generation-date": "2026-02-24T17:14:45.265Z"
1818
},
1919
"x-strapi-config": {
2020
"path": "/documentation",

0 commit comments

Comments
 (0)