Skip to content
This repository was archived by the owner on Jun 24, 2026. It is now read-only.

Commit 6190a79

Browse files
committed
Updated readme and scripts
1 parent 3c14b00 commit 6190a79

2 files changed

Lines changed: 38 additions & 29 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,21 @@ Install dependencies.
2626
npm install
2727
```
2828

29-
### Step 2. Create an environment file
29+
### Step 2. Create an account and grab your secrets
30+
31+
Create a Contentful account with an empty space.
32+
Go to your Contentful space and
33+
34+
- Find your [Space ID](https://www.contentful.com/help/find-space-id/)
35+
- Create an access token for the [Content Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/)
36+
- Create an access token for the [Content Management API](https://www.contentful.com/developers/docs/references/content-management-api/).
37+
38+
### Step 3. Create an environment file
3039

3140
1. Rename the `.env.example` at the root of your project to `.env` (so it is ignored by Git).
32-
2. Find your Contentful [Space ID](https://www.contentful.com/help/find-space-id/), your [Content Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/) access token, and [Content Management API](https://www.contentful.com/developers/docs/references/content-management-api/) access token.
33-
3. In the new `.env` file, replace `YOUR_SPACE_ID`, `YOUR_DELIVERY_TOKEN` and `YOUR_MANAGEMENT_ACCESS_TOKEN` with the correct values.
41+
2. In the new `.env` file, replace `YOUR_SPACE_ID`, `YOUR_DELIVERY_TOKEN` and `YOUR_MANAGEMENT_ACCESS_TOKEN` with the values from the previous step.
3442

35-
### Step 3. Import our content model
43+
### Step 4. Import our content model
3644

3745
The project comes with a Contentful set up command that imports the required content model and adds sample content to your space.
3846

@@ -42,7 +50,7 @@ Run the following command to import the content model.
4250
npm run setup
4351
```
4452

45-
### Step 4. Run the project locally
53+
### Step 5. Run the project locally
4654

4755
```bash
4856
npm run dev

‎package.json‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
{
2-
"name": "sveltekit-starter",
3-
"version": "0.0.1",
4-
"scripts": {
5-
"dev": "vite dev --open",
6-
"build": "vite build",
7-
"package": "svelte-kit package",
8-
"preview": "vite preview",
9-
"lint": "prettier --check --plugin-search-dir=. .",
10-
"format": "prettier --write --plugin-search-dir=. ."
11-
},
12-
"devDependencies": {
13-
"@sveltejs/adapter-auto": "next",
14-
"@sveltejs/kit": "next",
15-
"prettier": "^2.8.0",
16-
"prettier-plugin-svelte": "^2.8.1",
17-
"svelte": "^3.53.1",
18-
"vite": "^3.2.5"
19-
},
20-
"type": "module",
21-
"dependencies": {
22-
"@contentful/rich-text-html-renderer": "^16.0.2",
23-
"contentful-import": "^8.5.13",
24-
"dotenv": "^16.0.3"
25-
}
2+
"name": "sveltekit-starter",
3+
"version": "0.0.1",
4+
"scripts": {
5+
"dev": "vite dev --open",
6+
"build": "vite build",
7+
"package": "svelte-kit package",
8+
"preview": "vite preview",
9+
"lint": "prettier --check --plugin-search-dir=. .",
10+
"format": "prettier --write --plugin-search-dir=. .",
11+
"setup": "node ./contentful/setup.js"
12+
},
13+
"devDependencies": {
14+
"@sveltejs/adapter-auto": "next",
15+
"@sveltejs/kit": "next",
16+
"prettier": "^2.8.0",
17+
"prettier-plugin-svelte": "^2.8.1",
18+
"svelte": "^3.53.1",
19+
"vite": "^3.2.5"
20+
},
21+
"type": "module",
22+
"dependencies": {
23+
"@contentful/rich-text-html-renderer": "^16.0.2",
24+
"contentful-import": "^8.5.13",
25+
"dotenv": "^16.0.3"
26+
}
2627
}

0 commit comments

Comments
 (0)