Skip to content

Commit 65251fe

Browse files
yashranjan1yashranjan1
authored
docs: Update documentation with new features and installation instructions
2 parents 8f905bf + 0215b74 commit 65251fe

File tree

5 files changed

+37
-48
lines changed

5 files changed

+37
-48
lines changed

‎docs/images/banner.png‎

1.52 MB
Loading

‎docs/images/req-demo.gif‎

93.3 KB
Loading

‎docs/index.html‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,12 @@
1111

1212
<body>
1313
<article>
14-
<div><h1>Req - Test APIs with Terminal Velocity</h1><blockquote><b>Note</b>: This page is not up to date and serves as a boilerplate for the blog setup.</blockquote><p>A terminal-based API client built for the <a href="https://blog.boot.dev/news/hackathon-2025/">Boot.dev Hackathon 2025</a>.</p><h2>Features</h2><ul><li>Terminal user interface</li><li>Request collections</li><li>Environment variables</li><li>Request history</li></ul><h2>Tech Stack</h2><p>The project uses:</p><ol><li><b>Go</b> for core logic</li><li><b>Bubble Tea</b> for TUI</li><li><b>SQLite</b> for storage</li></ol><h3>Code Example</h3><pre>go
15-
func main() {
16-
fmt.Println("Hello, req!")
17-
}
18-
</pre><h2>Installation</h2><pre>bash
19-
go build -o req .
20-
./req
21-
</pre><h3>Commands</h3><ul><li><code>req --help</code> - Show help</li><li><code>req --verbose</code> - Verbose output</li></ul><h2>Lists Test</h2><p><b>Unordered list:</b>
22-
- Item one
23-
- Item two
24-
- Item three</p><p><b>Ordered list:</b>
25-
1. First step
26-
2. Second step
27-
3. Third step</p><h2>Text Formatting</h2><p>This has <b>bold text</b>, <i>italic text</i>, and <code>inline code</code>.</p><p>---</p><p>This blog is built with ❤️ using <a href="https://github.com/maniac-en/pyssg">pyssg</a> - A guided learning project at <a href="https://www.boot.dev/courses/build-static-site-generator">boot.dev</a></p></div>
14+
<div><img src="images/banner.png" alt="Req Banner" style="width: 100%; max-width: 800px; margin-bottom: 20px;"><h1>Req - Test APIs with Terminal Velocity</h1><p>A terminal-based API client built for the <a href="https://blog.boot.dev/news/hackathon-2025/">Boot.dev Hackathon 2025</a>.</p><h2>Features</h2><ul><li>Terminal user interface with beautiful TUI</li><li>Request collections and organization</li><li>Demo data generation with realistic APIs</li><li>Request builder with tabs for body, headers, query params</li><li>Production-ready logging system</li></ul><h2>Tech Stack</h2><p>The project uses:</p><ol><li><b>Go</b> for core logic and HTTP operations</li><li><b>Bubble Tea</b> for terminal user interface</li><li><b>SQLite</b> for file-based storage</li><li><b>SQLC</b> for type-safe database operations</li><li><b>Goose</b> for database migrations</li></ol><h2>Installation</h2><pre>bash
15+
go install github.com/maniac-en/req@v0.1.0
16+
req
17+
</pre><img src="images/req-demo.gif" alt="Demo GIF" style="width: 100%; max-width: 800px; margin: 20px 0;"><h2>What's Implemented</h2><ul><li>Collections CRUD operations (create, edit, delete, navigate)</li><li>Request builder interface with tabbed editing</li><li>Endpoint browsing with sidebar navigation</li><li>Demo data generation (JSONPlaceholder, ReqRes, HTTPBin APIs)</li><li>Beautiful warm color scheme with vim-like navigation</li><li>Pagination and real-time search filtering</li></ul><h2>Coming Soon</h2><ul><li>HTTP request execution (core feature)</li><li>Response viewer with syntax highlighting</li><li>Endpoint management (add/edit endpoints)</li><li>Environment variables support</li><li>Export/import functionality</li></ul><h2>Try It Out</h2><p><b>GitHub</b>: https://github.com/maniac-en/req
18+
<b>Installation</b>: <code>go install github.com/maniac-en/req@v0.1.0</code>
19+
<b>Usage</b>: Just run <code>req</code> in your terminal!</p><p>The app works completely offline with no external dependencies required.</p><p>---</p><p>This blog is built with ❤️ using <a href="https://github.com/maniac-en/pyssg">pyssg</a> - A guided learning project at <a href="https://www.boot.dev/courses/build-static-site-generator">boot.dev</a></p></div>
2820
</article>
2921
</body>
3022

‎web/content/index.md‎

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,57 @@
11
# Req - Test APIs with Terminal Velocity
22

3-
> **Note**: This page is not up to date and serves as a boilerplate for the blog setup.
4-
53
A terminal-based API client built for the [Boot.dev Hackathon 2025](https://blog.boot.dev/news/hackathon-2025/).
64

75
## Features
86

9-
- Terminal user interface
10-
- Request collections
11-
- Environment variables
12-
- Request history
7+
- Terminal user interface with beautiful TUI
8+
- Request collections and organization
9+
- Demo data generation with realistic APIs
10+
- Request builder with tabs for body, headers, query params
11+
- Production-ready logging system
1312

1413
## Tech Stack
1514

1615
The project uses:
1716

18-
1. **Go** for core logic
19-
2. **Bubble Tea** for TUI
20-
3. **SQLite** for storage
21-
22-
### Code Example
23-
24-
```go
25-
func main() {
26-
fmt.Println("Hello, req!")
27-
}
28-
```
17+
1. **Go** for core logic and HTTP operations
18+
2. **Bubble Tea** for terminal user interface
19+
3. **SQLite** for file-based storage
20+
4. **SQLC** for type-safe database operations
21+
5. **Goose** for database migrations
2922

3023
## Installation
3124

3225
```bash
33-
go build -o req .
34-
./req
26+
go install github.com/maniac-en/req@v0.1.0
27+
req
3528
```
3629

37-
### Commands
30+
## What's Implemented
3831

39-
- `req --help` - Show help
40-
- `req --verbose` - Verbose output
32+
- Collections CRUD operations (create, edit, delete, navigate)
33+
- Request builder interface with tabbed editing
34+
- Endpoint browsing with sidebar navigation
35+
- Demo data generation (JSONPlaceholder, ReqRes, HTTPBin APIs)
36+
- Beautiful warm color scheme with vim-like navigation
37+
- Pagination and real-time search filtering
4138

42-
## Lists Test
39+
## Coming Soon
4340

44-
**Unordered list:**
45-
- Item one
46-
- Item two
47-
- Item three
41+
- HTTP request execution (core feature)
42+
- Response viewer with syntax highlighting
43+
- Endpoint management (add/edit endpoints)
44+
- Environment variables support
45+
- Export/import functionality
4846

49-
**Ordered list:**
50-
1. First step
51-
2. Second step
52-
3. Third step
47+
## Try It Out
5348

54-
## Text Formatting
49+
**GitHub**: https://github.com/maniac-en/req
50+
**Installation**: `go install github.com/maniac-en/req@v0.1.0`
51+
**Usage**: Just run `req` in your terminal!
5552

56-
This has **bold text**, _italic text_, and `inline code`.
53+
The app works completely offline with no external dependencies required.
5754

5855
---
5956

60-
This blog is built with ❤️ using [pyssg](https://github.com/maniac-en/pyssg) - A guided learning project at [boot.dev](https://www.boot.dev/courses/build-static-site-generator)
57+
This blog is built with ❤️ using [pyssg](https://github.com/maniac-en/pyssg) - A guided learning project at [boot.dev](https://www.boot.dev/courses/build-static-site-generator)

‎web/req-demo.gif‎

93.3 KB
Loading

0 commit comments

Comments
 (0)