Skip to content
Merged
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
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@
## About

`req` is a lightweight, terminal-based API client built for the
[Boot.dev Hackathon 2025](https://github.com/maniac-en/req?tab=License-1-ov-file).
It features a fast and minimal text user interface and lets you create, send,
and inspect HTTP requests interactively from the command line. It is ideal for
testing APIs without leaving your terminal.
[Boot.dev Hackathon 2025](https://blog.boot.dev/news/hackathon-2025/#12-honorable-mentions-no-prizes-sorry), where it received an **honorable mention**.
**Current Status**: Early development (alpha). Core HTTP execution features are still in progress.

The goal is to provide a fast, minimal terminal interface for creating, sending,
and inspecting HTTP requests interactively from the command line.

> The app works completely offline with no external dependencies required.

Read more about `req` over here -
[Announcement Blog](https://maniac-en.github.io/req/)
Expand Down Expand Up @@ -52,7 +55,7 @@ req
## License

This project is licensed under the
[MIT License](https://github.com/maniac-en/req?tab=License-1-ov-file).
[MIT License](https://github.com/maniac-en/req/blob/main/LICENSE).

```
1. Mudassir Bilal (mailto:mughalmudassir966@gmail.com)
Expand Down
5 changes: 3 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,10 @@ The release workflow automatically builds:
- `req-v0.1.0-alpha.2-windows-amd64.exe`

### Release Notes
Automatically generated with:
Generated from template in `.github/workflows/release.yml` including:
- Project description
- Installation instructions (`go install` and binary downloads)
- Breaking change warnings (database cleanup instructions)
- Usage information
- Development stage disclaimer
- Link to full changelog
Expand Down Expand Up @@ -134,7 +135,7 @@ No fixed schedule. Releases are created when:
- Important bug fixes are ready
- Milestone requirements are met

For hackathon timeline, aim for `v0.1.0-alpha.x` releases as features are completed.
Release `v0.1.0-alpha.x` versions as features are completed and tested.

## Rollback Process

Expand Down
41 changes: 18 additions & 23 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,9 @@
<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/">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>
<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>
Expand All @@ -45,27 +38,29 @@ <h2>Installation</h2>
</pre><video src="/req/demo.mp4" controls style="width: 100%; max-width: 800px; margin: 20px 0;"></video>
<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>
<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>Endpoint management (add/edit endpoints)</li>
<li>Complete endpoint management</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<br>
<b>Installation</b>: <code>go install github.com/maniac-en/req@latest</code> or <code>go install github.com/maniac-en/req@v0.1.0</code><br>
<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><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>
Expand Down
Loading