[dev-docs] Add prebuild to check for .env vars

Author: hariria

README.md

@@ -4,7 +4,9 @@
   - [Installation](#installation)
     - [Requirements](#requirements)
   - [Clone the Developer docs repo](#clone-the-developer-docs-repo)
-  - [Build and serve the docs locally](#build-and-serve-the-docs-locally)
+  - [Install deps](#install-deps)
+  - [Develop on Nextra (New)](#develop-on-nextra-new)
+  - [Develop on Docusaurus (Legacy)](#develop-on-docusaurus-legacy)
   - [Debugging](#debugging)
   - [Regenerating contributors](#regenerating-contributors)
 
@@ -41,45 +43,66 @@ curl -fsSL https://get.pnpm.io/install.sh | sh -
 git clone https://github.com/aptos-labs/developer-docs.git
 ```
 
-## Build and serve the docs locally
-
-1. Run `pnpm`.
+## Install deps
 
 ```sh
 pnpm install
 ```
 
-2. Build the repository
+## Develop on Nextra (New)
+
+> Note: PLEASE SEE `apps/nextra/README.md` for more details!
+
+
+0. Setup environment
+
+Ensure you have configured your `.env` properly under `apps/nextra/.env`. There is a `.env.example` there that you can duplicate and rename to `.env` for simplicity.
+
+To ensure you have the right setup, you can run
 
 ```sh
-pnpm build
+pnpm prebuild
 ```
 
-3. Navigate to the correct subdirectory
+1. Build Nextra
 
-**Docusaurus**
-```sh
-cd apps/docusaurus
+```bash
+npx turbo run build --filter={apps/nextra}...
 ```
 
-**Nextra**
+This will build `apps/nextra` and all local packages it depends on.
+
+2. Navigate to the correct subdirectory
+
 ```sh
 cd apps/nextra
 ```
 
-4. Run the development server
+3. Run development server
 
-**Docusaurus**
 ```sh
-pnpm serve
+pnpm dev
 ```
 
-**Nextra**
+## Develop on Docusaurus (Legacy)
+
+1. Navigate to the correct subdirectory
+
 ```sh
-pnpm dev
+cd apps/docusaurus
 ```
 
-See the README.md in each respective app for more information
+2. Build the repository
+
+```sh
+pnpm build
+```
+
+3. Navigate to the correct subdirectory
+
+```sh
+pnpm serve
+```
 
 ## Debugging
 

apps/nextra/.env.example

@@ -0,0 +1 @@
+NEXT_PUBLIC_ORIGIN="http://localhost:3030"

apps/nextra/README.md

@@ -10,7 +10,7 @@ the local dev server:
 1. From the root of the `developer-docs` directory, run:
 
 ```bash filename="Terminal"
-pnpm i && pnpm build
+pnpm i
 ```
 
 2. Navigate back to `nextra`
@@ -21,6 +21,9 @@ Create a `.env` file in the root of `nextra` with the following
 NEXT_PUBLIC_ORIGIN="http://localhost:3030"
 ```
 
+Note: There is an example at `apps/nextra/.env.example` that
+you can duplicate and rename the duplicate to `.env`.
+
 3. Then run
 
 ```bash filename="Terminal"

package.json

@@ -2,6 +2,7 @@
   "name": "developer-docs",
   "private": true,
   "scripts": {
+    "prebuild": "node prebuild.js",
     "build": "turbo build",
     "dev": "turbo dev",
     "lint": "turbo lint",

prebuild.js

@@ -0,0 +1,22 @@
+const fs = require("fs");
+const path = require("path");
+
+const ENV_FILE = path.join(__dirname, "apps/nextra/.env");
+
+try {
+  if (!fs.existsSync(ENV_FILE)) {
+    console.error("Error: .env file does not exist under apps/nextra.");
+    process.exit(1);
+  }
+
+  const envFileContent = fs.readFileSync(ENV_FILE, "utf8");
+  if (!envFileContent.includes("NEXT_PUBLIC_ORIGIN=")) {
+    console.error("Error: NEXT_PUBLIC_ORIGIN is not defined in the .env file.");
+    process.exit(1);
+  }
+
+  console.log("Pre-build check passed.");
+} catch (err) {
+  console.error("An error occurred during the pre-build check:", err);
+  process.exit(1);
+}