diff --git a/docs/getting-started/2026-03-15-13-08-39.png b/docs/getting-started/2026-03-15-13-08-39.png new file mode 100644 index 0000000..6bfed52 Binary files /dev/null and b/docs/getting-started/2026-03-15-13-08-39.png differ diff --git a/docs/getting-started/2026-03-15-13-08-40.png b/docs/getting-started/2026-03-15-13-08-40.png new file mode 100644 index 0000000..6bfed52 Binary files /dev/null and b/docs/getting-started/2026-03-15-13-08-40.png differ diff --git a/docs/getting-started/2026-03-15-13-10-06.png b/docs/getting-started/2026-03-15-13-10-06.png new file mode 100644 index 0000000..bbdc933 Binary files /dev/null and b/docs/getting-started/2026-03-15-13-10-06.png differ diff --git a/docs/getting-started/2026-03-15-13-10-08.png b/docs/getting-started/2026-03-15-13-10-08.png new file mode 100644 index 0000000..bbdc933 Binary files /dev/null and b/docs/getting-started/2026-03-15-13-10-08.png differ diff --git a/docs/getting-started/2026-03-15-13-10-58.png b/docs/getting-started/2026-03-15-13-10-58.png new file mode 100644 index 0000000..0fc6d24 Binary files /dev/null and b/docs/getting-started/2026-03-15-13-10-58.png differ diff --git a/docs/getting-started/2026-03-15-13-12-41.png b/docs/getting-started/2026-03-15-13-12-41.png new file mode 100644 index 0000000..dda2a97 Binary files /dev/null and b/docs/getting-started/2026-03-15-13-12-41.png differ diff --git "a/docs/getting-started/Screenshot 2026-03-03 at 5.14.26\342\200\257PM.png" "b/docs/getting-started/Screenshot 2026-03-03 at 5.14.26\342\200\257PM.png" new file mode 100644 index 0000000..9309608 Binary files /dev/null and "b/docs/getting-started/Screenshot 2026-03-03 at 5.14.26\342\200\257PM.png" differ diff --git "a/docs/getting-started/Screenshot 2026-03-09 at 7.41.45\342\200\257AM.png" "b/docs/getting-started/Screenshot 2026-03-09 at 7.41.45\342\200\257AM.png" new file mode 100644 index 0000000..e784b4c Binary files /dev/null and "b/docs/getting-started/Screenshot 2026-03-09 at 7.41.45\342\200\257AM.png" differ diff --git "a/docs/getting-started/Screenshot 2026-03-15 at 11.57.36\342\200\257AM.png" "b/docs/getting-started/Screenshot 2026-03-15 at 11.57.36\342\200\257AM.png" new file mode 100644 index 0000000..c3bb68e Binary files /dev/null and "b/docs/getting-started/Screenshot 2026-03-15 at 11.57.36\342\200\257AM.png" differ diff --git "a/docs/getting-started/Screenshot 2026-03-15 at 12.23.26\342\200\257PM.png" "b/docs/getting-started/Screenshot 2026-03-15 at 12.23.26\342\200\257PM.png" new file mode 100644 index 0000000..3f684b2 Binary files /dev/null and "b/docs/getting-started/Screenshot 2026-03-15 at 12.23.26\342\200\257PM.png" differ diff --git a/docs/getting-started/image.png b/docs/getting-started/image.png new file mode 100644 index 0000000..bbdc933 Binary files /dev/null and b/docs/getting-started/image.png differ diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md new file mode 100644 index 0000000..61284cd --- /dev/null +++ b/docs/getting-started/quick-start.md @@ -0,0 +1,66 @@ +# Getting Started with RestBolt + +## Installation + +### Prerequisites +- Node.js 18 or higher +- npm or yarn + +### Steps +1. Clone the repository +2. Install dependencies +3. Start development server +4. Open in browser + +## Your First Request + +Let's send your first API request! + +![](2026-03-15-13-08-39.png) + +### Step 1: Enter a URL +Click the URL bar and enter: +`https://jsonplaceholder.typicode.com/posts/1` + +### Step 2: Click Send +Click the "Send" button or press Cmd/Ctrl+Enter + +![](2026-03-15-13-10-06.png) + +### Step 3: View the Response +The response appears on the right side, beautifully formatted! + +🎉 Congratulations! You've sent your first request with RestBolt! + +## Common Pitfalls and Solutions + +### Node.js version requirements +Node.js 18+ is required to run RestBolt (https://nodejs.org/en/download). If you run RestBolt with an older version, you might encounter the following error: + +![](2026-03-15-13-10-58.png) + +When running `npm run dev`, you will receive this message if the version is older than required: + +``` +You are using Node.js 16.20.2. For Next.js, Node.js version "^18.18.0 || ^19.8.0 +| >= 20.0.0" is required. +``` + +To check your Node.js version, use the following command in Terminal: +`node -v` + +### Ensure `npm install` completes before running `npm run dev` +Before running `npm run dev`, you should receive the following output. This indicates `npm install` has been completed. + +![](2026-03-15-13-12-41.png) + +### RestBolt is a local-first (IndexedDB) application +There is no backend server to configure when using RestBolt. Benefits include: + +* Immediate UX: Provides low-latency and immediate interactions. +* Offline capability: Features remain available without an active network. + +## What's Next? +- Learn about Collections +- Try the Chain Builder +- Set up Environments \ No newline at end of file