Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/getting-started/2026-03-15-13-08-39.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting-started/2026-03-15-13-08-40.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting-started/2026-03-15-13-10-06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting-started/2026-03-15-13-10-08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting-started/2026-03-15-13-10-58.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting-started/2026-03-15-13-12-41.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting-started/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
@@ -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