Skip to content

Commit eb7747a

Browse files
authored
Merge pull request #108 from strapi/chore/update-readme-file
update README.md to fix the setup instructins ISSUE# 107
2 parents acb173f + 3f8cb0a commit eb7747a

1 file changed

Lines changed: 30 additions & 17 deletions

File tree

README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,44 +12,57 @@ This repository contains the following:
1212

1313
Strap yourself in! You can get started with this project on your local machine by following the instructions below, or you can [request a private instance on our website](https://strapi.io/demo)
1414

15-
## 1. Clone Launchpad
15+
### Prerequisites
1616

17-
To infinity and beyond! 🚀 Before you take off, clone the repo and set it up:
17+
- **Node.js** v18 or higher
18+
- **Yarn** as your package manager (this project uses Yarn internally for its scripts)
19+
20+
> **Don't have Yarn installed?** You can enable it via Node.js Corepack:
21+
> ```sh
22+
> corepack enable
23+
> ```
24+
> Or install it globally via npm:
25+
> ```sh
26+
> npm install -g yarn
27+
> ```
28+
29+
## 1. Clone and Install
30+
31+
To infinity and beyond! Clone the repo and install root dependencies:
1832
1933
```sh
2034
git clone https://github.com/strapi/launchpad.git
2135
cd launchpad
22-
yarn
23-
yarn run setup
36+
yarn install
2437
```
2538
26-
This will clone the repo, install dependencies in both projects (Strapi and Next.js), and run the `setup` scripts to get you started.
27-
28-
## 2. Start Strapi
39+
## 2. Setup
2940

30-
Navigate to your `./launchpad/strapi` folder and start the server:
41+
Run the setup script to install dependencies in both projects (Strapi and Next.js) and copy the environment files:
3142

3243
```sh
33-
cd strapi
34-
yarn dev
44+
yarn setup
3545
```
3646

37-
This will install dependencies, sprinkle in some data magic, and run the server.
47+
## 3. Seed the Data
48+
49+
Populate your Strapi instance with demo content:
3850

39-
## 3. Start Next.js
51+
```sh
52+
yarn seed
53+
```
4054

41-
We're almost ready for lift-off! Next.js is your sleek, futuristic interface for getting all that glorious content out into the world. 🚀
55+
## 4. Start the Development Servers
4256

43-
Open a new terminal tab or window to leave Strapi running, and navigate to your `./launchpad/next` and start the server:
57+
Launch both Strapi and Next.js concurrently from the root:
4458

4559
```sh
46-
cd next
4760
yarn dev
4861
```
4962

50-
This installs dependencies, builds your project, and starts your server. Youre now a spacefaring content master!
63+
This starts the Strapi server first, waits for it to be ready, then starts the Next.js frontend. You're now a spacefaring content master!
5164

52-
You're all set! Visit http://localhost:1337/admin to create your first Strapi user, and http://localhost:3000 to discover your space rocket website.
65+
Visit http://localhost:1337/admin to create your first Strapi user, and http://localhost:3000 to discover your space rocket website.
5366

5467
## Features Overview ✨
5568

0 commit comments

Comments
 (0)