Merge pull request #102 from strapi/update/readme

pierreburgy · web-flow · commit 16ed4f073ff7 · 2026-01-12T12:12:55.000+01:00
Update Readme
diff --git a/README.md b/README.md
@@ -14,91 +14,75 @@ Strap yourself in! You can get started with this project on your local machine b
 
 ## 1. Clone Launchpad
 
-To infinity and beyond! 🚀 Clone the repo with this command:
+To infinity and beyond! 🚀 Before you take off, clone the repo and set it up:
 
-```
+```sh
 git clone https://github.com/strapi/launchpad.git
+cd launchpad
+yarn
+yarn run setup
 ```
 
-- Navigate to your project folder by running `cd launchpad`.
-
-## 2. Set up environment variables
+This will clone the repo, install dependencies in both projects (Strapi and Next.js), and run the `setup` scripts to get you started.
 
-Before you take off, set up the required environment variables for both Strapi and Next.js.
+## 2. Start Strapi
 
-To create the Strapi .env file, copy the content of the `./strapi/.env.example` file into a new file named `./strapi/.env`, then modify the values to match your setup:
+Navigate to your `./launchpad/strapi` folder and start the server:
 
 ```sh
-cp ./strapi/.env.example ./strapi/.env
-```
-
-Then do the same for the Next.js .env file, and modify it too:
-
-```sh
-cp ./next/.env.example ./next/.env
-```
-
-## 3. Start Strapi
-
-Take a deep breath. It's time to power up the Strapi engines. Navigate to your ./my-projects/launchpad/strapi folder by running:
-
-Navigate to your `./my-projects/launchpad/strapi` folder by running `cd strapi` from your command line.
-
-- Run the following command in your `./launchpad/strapi` folder:
-
-```
-yarn && yarn seed && yarn develop
+cd strapi
+yarn dev
 ```
 
-This will install dependencies, sprinkle in some data magic, and run the server. (You can run these commands separately, but why not be efficient?)
+This will install dependencies, sprinkle in some data magic, and run the server.
 
-## 4. Start Next.js
+## 3. Start Next.js
 
 We're almost ready for lift-off! Next.js is your sleek, futuristic interface for getting all that glorious content out into the world. 🚀
 
-Open a new terminal tab or window to leave Strapi running, and navigate to your `./my-projects/launchpad/next` folder by running `cd next`.
+Open a new terminal tab or window to leave Strapi running, and navigate to your `./launchpad/next` and start the server:
 
-- Run the following command in your `./launchpad/next` folder
-
-```
-yarn && yarn build && yarn start
+```sh
+cd next
+yarn dev
 ```
 
 This installs dependencies, builds your project, and starts your server. You’re now a spacefaring content master!
 
+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.
+
 ## Features Overview ✨
 
 ### User
 
 <br />
 
-**An intuitive, minimal editor** The editor allows you to pull in dynamic blocks of content. It’s 100% open-source, and it’s fully extensible.<br />
-**Media Library** Upload images, video or any files and crop and optimize their sizes, without quality loss.<br />
-**Flexible content management** Build any type of category, section, format or flow to adapt to your needs. <br />
-**Sort and Filter** Built-in sorting and filtering: you can manage thousands of entries without effort.<br />
-**User-friendly interface** The most user-friendly open-source interface on the market.<br />
-**SEO optimized** Easily manage your SEO metadata with a repeatable field and use our Media Library to add captions, notes, and custom filenames to optimize the SEO of media assets.<br /><br />
+ - **An intuitive, minimal editor** The editor allows you to pull in dynamic blocks of content. It’s 100% open-source, and it’s fully extensible.<br />
+ - **Media Library** Upload images, video or any files and crop and optimize their sizes, without quality loss.<br />
+ - **Flexible content management** Build any type of category, section, format or flow to adapt to your needs. <br />
+ - **Sort and Filter** Built-in sorting and filtering: you can manage thousands of entries without effort.<br />
+ - **User-friendly interface** The most user-friendly open-source interface on the market.<br />
+ - **SEO optimized** Easily manage your SEO metadata with a repeatable field and use our Media Library to add captions, notes, and custom filenames to optimize the SEO of media assets.<br /><br />
 
 ### Global
 
 <br />
 
-[Customizable API](https://strapi.io/features/customizable-api): Automatically build out the schema, models, controllers for your API from the editor. Get REST or GraphQL API out of the box without writing a single line of code.<br />
-[Media Library](https://strapi.io/features/media-library): The media library allows you to store your images, videos and files in your Strapi admin panel with many ways to visualize and manage them.<br />
-[Role-Based Access Control (RBAC)](https://strapi.io/features/custom-roles-and-permissions): Role-Based Access Control is a feature available in the Administration Panel settings that let your team members have access rights only to the information they need.<br />
-[Internationalization (i18n)](https://strapi.io/features/internationalization): Internationalization (i18n) lets you create many content versions, also called locales, in different languages and for different countries.<br />
-[Audit Logs](https://strapi.io/blog/reasons-and-best-practices-for-using-audit-logs-in-your-application)The Audit Logs section provides a searchable and filterable display of all activities performed by users of the Strapi application<br />
-[Data transfer](https://strapi.io/blog/importing-exporting-and-transferring-data-with-the-strapi-cli) Streams your data from one Strapi instance to another Strapi instance.<br />
-[Review Worfklows](https://docs.strapi.io/user-docs/settings/review-workflows) Create and manage any desired review stages for your content, enabling your team to collaborate in the content creation flow from draft to publication. <br />
+ - [Customizable API](https://strapi.io/features/customizable-api): Automatically build out the schema, models, controllers for your API from the editor. Get REST or GraphQL API out of the box without writing a single line of code.<br />
+ - [Media Library](https://strapi.io/features/media-library): The media library allows you to store your images, videos and files in your Strapi admin panel with many ways to visualize and manage them.<br />
+ - [Role-Based Access Control (RBAC)](https://strapi.io/features/custom-roles-and-permissions): Role-Based Access Control is a feature available in the Administration Panel settings that let your team members have access rights only to the information they need.<br />
+ - [Internationalization (i18n)](https://strapi.io/features/internationalization): Internationalization (i18n) lets you create many content versions, also called locales, in different languages and for different countries.<br />
+ - [Audit Logs](https://strapi.io/blog/reasons-and-best-practices-for-using-audit-logs-in-your-application): The Audit Logs section provides a searchable and filterable display of all activities performed by users of the Strapi application<br />
+ - [Data transfer](https://strapi.io/blog/importing-exporting-and-transferring-data-with-the-strapi-cli): Streams your data from one Strapi instance to another Strapi instance.<br />
+ - [Review Worfklows](https://docs.strapi.io/user-docs/settings/review-workflows): Create and manage any desired review stages for your content, enabling your team to collaborate in the content creation flow from draft to publication. <br />
 
 ## Resources
 
-[Docs](https://docs.strapi.io) • [Demo](https://strapi.io/demo) • [Forum](https://forum.strapi.io/) • [Discord](https://discord.strapi.io) • [Youtube](https://www.youtube.com/c/Strapi/featured) • [Strapi Design System](https://design-system.strapi.io/) • [Marketplace](https://market.strapi.io/) • [Cloud Free Trial](https://cloud.strapi.io)
+[Docs](https://docs.strapi.io) • [Discord](https://discord.strapi.io) • [YouTube](https://www.youtube.com/c/Strapi/featured) • [Strapi Design System](https://design-system.strapi.io/) • [Marketplace](https://market.strapi.io/) • [Cloud Free Trial](https://cloud.strapi.io)
 
 ## Todo
 
 - [ ] Implement the official Strapi SEO plugin
-- [ ] Implement the community Strapi preview plugin
 - [ ] Create localized content for the pricing plans and products
 - [ ] Populate creator fields when it'll work on Strapi 5 (article authors information are missing)
 
diff --git a/next/.env.example b/next/.env.example
@@ -2,4 +2,4 @@ WEBSITE_URL=http://localhost:3000 # Add the correct ENV var for this onto your h
 PORT=3000
 
 NEXT_PUBLIC_API_URL=http://localhost:1337
-PREVIEW_SECRET=tobemodified 
+PREVIEW_SECRET=preview_secret
diff --git a/package.json b/package.json
@@ -7,9 +7,9 @@
     "prepare": "husky",
     "next": "yarn dev --prefix ../next/",
     "strapi": "yarn dev --prefix ../strapi/",
-    "setup:next": "cd next && yarn && node --loader ts-node/esm ../scripts/copy-env.mts ./",
-    "setup:strapi": "cd strapi && yarn && node --loader ts-node/esm ../scripts/copy-env.mts ./",
-    "setup": "yarn install && yarn setup:next && yarn setup:strapi",
+    "setup:next": "cd next && yarn && node --loader ts-node/esm ../scripts/copy-env.mts ../next",
+    "setup:strapi": "cd strapi && yarn && node --loader ts-node/esm ../scripts/copy-env.mts  ../strapi",
+    "setup": "yarn && yarn setup:next && yarn setup:strapi",
     "dev": "yarn concurrently \"cd strapi && yarn develop\" \"npx wait-on http://localhost:1337 && cd next && yarn dev\"",
     "seed": "cd strapi && yarn strapi import -f ./data/export_20250116105447.tar.gz --force",
     "export": "cd strapi && yarn strapi export --no-encrypt -f ./data/export_20250116105447",
@@ -27,10 +27,12 @@
   },
   "devDependencies": {
     "@trivago/prettier-plugin-sort-imports": "^5.2.2",
+    "dotenv": "^17.2.3",
     "husky": "^9.1.7",
     "lint-staged": "^15.2.10",
     "prettier": "^3.5.3",
-    "ts-node": "^10.9.2"
+    "ts-node": "^10.9.2",
+    "uuid": "^13.0.0"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx,json,md,yml,yaml}": [
diff --git a/scripts/copy-env.mts b/scripts/copy-env.mts
@@ -1,5 +1,15 @@
 import * as fs from 'fs';
 import * as path from 'path';
+import { v4 as uuidv4 } from 'uuid';
+import dotenv from 'dotenv'
+
+dotenv.config({ path: '../next/.env' })
+
+const TO_BE_MODIFIED_KEY = /tobemodified/g;
+const PREVIEW_SECRET_KEY = 'preview_secret';
+
+const generateSecret = () => uuidv4().replace(/-/g, '_');
+const previewSecret = process.env.PREVIEW_SECRET || generateSecret();
 
 function copyEnvFile(targetDir: string): void {
   // Ensure targetDir is trimmed
@@ -27,6 +37,19 @@ function copyEnvFile(targetDir: string): void {
             return;
           }
           console.log(`.env.example has been copied to ${envPath}`);
+
+          // Update env variables with generated secrets
+          const currentEnv = fs.readFileSync(envPath, 'utf8');
+        
+          // Replace all occurrences with a new secret
+          const updatedEnv = currentEnv
+            .replace(TO_BE_MODIFIED_KEY, generateSecret)
+            .replace(PREVIEW_SECRET_KEY, previewSecret)
+
+          // Rewrite .env file with updated env variables
+          fs.writeFileSync(envPath, updatedEnv, 'utf8');
+
+          console.log(`${envPath} has been updated with new secrets.`);
         });
       } else {
         // .env file exists, no action needed
diff --git a/strapi/.env.example b/strapi/.env.example
@@ -1,11 +1,10 @@
 HOST=0.0.0.0
 PORT=1337
-APP_KEYS="toBeModified1,toBeModified2"
+APP_KEYS="tobemodified1,tobemodified2"
 API_TOKEN_SALT=tobemodified
 ADMIN_JWT_SECRET=tobemodified
 TRANSFER_TOKEN_SALT=tobemodified
 JWT_SECRET=tobemodified
 
-
 CLIENT_URL=http://localhost:3000
-PREVIEW_SECRET=tobemodified # optional, required with Next.js draft mode
+PREVIEW_SECRET=preview_secret # optional, required with Next.js draft mode
diff --git a/strapi/package.json b/strapi/package.json
@@ -5,6 +5,7 @@
   "description": "A Strapi application",
   "scripts": {
     "develop": "strapi develop",
+    "dev": "strapi develop",
     "start": "strapi start",
     "build": "strapi build",
     "strapi": "strapi",
@@ -36,7 +37,7 @@
     "name": "A Strapi developer"
   },
   "strapi": {
-    "uuid": "LAUNCHPAD-LOCAL"
+    "uuid": "LAUNCHPAD"
   },
   "engines": {
     "node": ">=18.0.0 <=22.x.x",
diff --git a/yarn.lock b/yarn.lock
@@ -519,6 +519,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"dotenv@npm:^17.2.3":
+  version: 17.2.3
+  resolution: "dotenv@npm:17.2.3"
+  checksum: 10c0/c884403209f713214a1b64d4d1defa4934c2aa5b0002f5a670ae298a51e3c3ad3ba79dfee2f8df49f01ae74290fcd9acdb1ab1d09c7bfb42b539036108bb2ba0
+  languageName: node
+  linkType: hard
+
 "dunder-proto@npm:^1.0.1":
   version: 1.0.1
   resolution: "dunder-proto@npm:1.0.1"
@@ -1153,11 +1160,13 @@ __metadata:
     "@trivago/prettier-plugin-sort-imports": "npm:^5.2.2"
     "@types/node": "npm:^22.5.2"
     concurrently: "npm:^8.2.2"
+    dotenv: "npm:^17.2.3"
     husky: "npm:^9.1.7"
     lint-staged: "npm:^15.2.10"
     prettier: "npm:^3.5.3"
     ts-node: "npm:^10.9.2"
     typescript: "npm:^5.0.0"
+    uuid: "npm:^13.0.0"
     wait-on: "npm:^8.0.1"
   languageName: unknown
   linkType: soft
@@ -1324,6 +1333,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"uuid@npm:^13.0.0":
+  version: 13.0.0
+  resolution: "uuid@npm:13.0.0"
+  bin:
+    uuid: dist-node/bin/uuid
+  checksum: 10c0/950e4c18d57fef6c69675344f5700a08af21e26b9eff2bf2180427564297368c538ea11ac9fb2e6528b17fc3966a9fd2c5049361b0b63c7d654f3c550c9b3d67
+  languageName: node
+  linkType: hard
+
 "v8-compile-cache-lib@npm:^3.0.1":
   version: 3.0.1
   resolution: "v8-compile-cache-lib@npm:3.0.1"
