req/docs/index.html at cd3aa8e2f267301e4290f72cdb7583a755315add · overhttps/req · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title> Req - Test APIs with Terminal Velocity </title>
    <link href="/req/index.css" rel="stylesheet">

</head>

<body>
    <article>
        <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/#12-honorable-mentions-no-prizes-sorry">Boot.dev
                    Hackathon 2025</a>, where it received an <b>honorable mention</b>.</p>
            <p><b>Current Status:</b> Early development (alpha). Core HTTP execution features are still in progress.</p>
            <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
# Install the latest stable release
go install github.com/maniac-en/req@latest

# Or install a specific version (e.g., v0.1.0)
go install github.com/maniac-en/req@v0.1.0

# Run the application
req
            </pre><video src="/req/demo.mp4" controls style="width: 100%; max-width: 800px; margin: 20px 0;"></video>
            <h2>What's Implemented</h2>
            <ul>
                <li>TUI interface with collections and endpoints navigation</li>
                <li>SQLite-based storage with migrations</li>
                <li>Basic request builder interface</li>
            </ul>
            <h2>Coming Soon</h2>
            <ul>
                <li>HTTP request execution (core feature)</li>
                <li>Response viewer with syntax highlighting</li>
                <li>Complete endpoint management</li>
                <li>Environment variables support</li>
            </ul>
            <h2>Try It Out</h2>

            <p><strong>GitHub Repository:</strong><br>
            <a href="https://github.com/maniac-en/req">https://github.com/maniac-en/req</a></p>

            <p><strong>Installation:</strong></p>
            <pre>go install github.com/maniac-en/req@latest</pre>

            <p><strong>Usage:</strong></p>
            <pre>req</pre>

            <p><em>Note: The app works completely offline with no external dependencies required.</em></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>
    </article>
</body>

</html>