Skip to content
This repository was archived by the owner on Mar 12, 2025. It is now read-only.

Commit edc0a45

Browse files
committed
add missing steps
1 parent 5ffdb6c commit edc0a45

File tree

3 files changed

+21
-16
lines changed

3 files changed

+21
-16
lines changed

docs/README.md

+19-14
Original file line numberDiff line numberDiff line change
@@ -28,35 +28,40 @@ This repository contains 3 separate apps:
2828

2929
1. Change directory to `publish-backend` directory
3030

31-
1. Create a copy of the `.env.example` file and name it `.env`.
31+
2. Create a copy of the `.env.example` file and name it `.env`
3232

33-
1. Run `docker compose up`
33+
3. Run `npm install`
3434

35-
1. Run `npm run cs import` to import config from `config/sync/*` files into
36-
database
35+
4. Run `docker compose up`
3736

38-
Visit http://localhost:1337/admin to access the admin panel.
37+
5. In another terminal, go to `publish-backend` and run `npm run cs import`.
38+
This will import config from `config/sync/*` files into the database.
3939

40-
You will be prompted to create an Admin account if there is no account in your
41-
local environment yet.
40+
6. Visit http://localhost:1337/admin to access the admin panel
41+
42+
7. You will be prompted to create an Admin account if there is no account in
43+
your local environment yet. Create an account here.
44+
45+
Note: This is an account to login to the admin panel. It's different from the
46+
account to login to the frontend app.
4247

4348
### Run publish-frontend (Next.js) app
4449

4550
1. In another terminal, go to `publish-frontend` directory
46-
1. Create a copy of the `sample.env.local` file and name it `.env.local`. Add
51+
2. Create a copy of the `sample.env.local` file and name it `.env.local`. Add
4752
required values.
48-
1. Run `npm install`
49-
1. Make sure the backend Strapi app is running in another terminal. Then start
53+
3. Run `npm install`
54+
4. Make sure the backend Strapi app is running in another terminal. Then start
5055
the frontend Next.js app by running `npm run dev`.
51-
1. Visit http://localhost:3000/ to access the authoring site
56+
5. Visit http://localhost:3000/ to access the authoring site
5257

5358
### Run publish-11ty-test (11ty) app
5459

5560
1. In another terminal, go to `publish-11ty-test` directory
56-
1. Run `yarn install`
57-
1. Make sure the backend Strapi app is running in another terminal. Then run
61+
2. Run `yarn install`
62+
3. Make sure the backend Strapi app is running in another terminal. Then run
5863
`yarn serve` to build the static site and serve it.
59-
1. Visit http://localhost:8080/ to see the user-facing site
64+
4. Visit http://localhost:8080/ to see the user-facing site
6065

6166
- If you made changes to the contents saved in the backend database, you will
6267
need to re-build the static site by running `yarn serve` again to see the

publish-backend/src/extensions/documentation/documentation/1.0.0/full_documentation.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"termsOfService": null,
88
"contact": null,
99
"license": null,
10-
"x-generation-date": "2023-08-09T12:27:12.437Z"
10+
"x-generation-date": "2023-08-09T14:13:27.005Z"
1111
},
1212
"x-strapi-config": {
1313
"path": "/documentation",

publish-backend/src/extensions/documentation/public/index.html

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)