Skip to content

Commit e6f445d

Browse files
committed
update readme
1 parent e9bc627 commit e6f445d

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,36 @@
11
## Getting Started
22

3-
First, install dependencies:
3+
### Steps to run the project
4+
5+
- Install dependencies:
46

57
```bash
68
npm install
79
# or
810
yarn
911
```
1012

11-
Then run the development server:
12-
13-
```bash
14-
npm run dev
15-
# or
16-
yarn dev
17-
```
13+
- **`!!! Make sure to have installed Sanity globally`**
14+
Check sanity docs for more info: https://www.sanity.io/docs/getting-started-with-sanity-cli
1815

19-
### Settings
2016

21-
Create a file `.env.local` and put inside:
17+
- Create a file `.env.local` and put inside:
2218

23-
1. NEXT_PUBLIC_SANITY_URL="https://f2g1h82s.api.sanity.io/v2021-10-21/data/query/production", where **f2g1h82s** is your sanity project ID
24-
2. NEXT_PUBLIC_SANITY_LATEST_PROJECTS="?query=...", your query to get latest projects
25-
3. NEXT_PUBLIC_SANITY_ALL_PROJECTS="?query=...", your query to get all projects
26-
4. NEXT_PUBLIC_SANITY_TOKEN="", sanity token created in sanity studio under API section
19+
1. NEXT_PUBLIC_SANITY_URL=""
20+
2. NEXT_PUBLIC_SANITY_LATEST_PROJECTS=""
21+
3. NEXT_PUBLIC_SANITY_ALL_PROJECTS=""
22+
4. NEXT_PUBLIC_SANITY_PROJECTS=""
23+
5. NEXT_PUBLIC_SANITY_PROJECT_BY_CATEGORY=""
24+
6. NEXT_PUBLIC_SANITY_TOKEN=""
2725

28-
Run Sanity (localhost:3333)
26+
!!! Please, take into account that you need to create a token in Sanity Studio, and put it in NEXT_PUBLIC_SANITY_TOKEN.
2927

30-
#### **`!!! Make sure to have installed Sanity globally`**
28+
Also, the points from 2 to 5 are queries to get data from Sanity. It's up to you to create them. Otherwise, you can use your own queries.
3129

32-
Then:
30+
- Finally, run the development server:
3331

3432
```bash
35-
cd sanity && sanity start
36-
```
37-
38-
It runs local server at localhost:3333
33+
npm run dev
34+
# or
35+
yarn dev
36+
```

0 commit comments

Comments
 (0)