You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-13Lines changed: 26 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,24 +18,37 @@ Some requirements are:
18
18
19
19
## Run locally using sqlite3
20
20
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).
22
22
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:**
24
24
25
-
```
26
-
yarn dev
27
-
```
25
+
1.**Build the project** (required before running):
28
26
29
-
Then visit:
27
+
```bash
28
+
yarn build
29
+
```
30
30
31
-
-**Admin**: <http://localhost:1337/admin>
31
+
2.**Create a `.env` file** and set at least `APP_KEYS` (required for the app to start):
32
32
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
+
```
34
36
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.
39
52
40
53
## Dev locally using PostreSQL
41
54
@@ -64,7 +77,7 @@ yarn dev
64
77
65
78
# 👷♀️ Build
66
79
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:
0 commit comments