Skip to content

Asmit1211/cli-forum

Repository files navigation

CLI Forum

A terminal-style forum interface that provides developers with a command-line experience for browsing and participating in forum discussions. The application integrates with the Foru.ms API to deliver real-time forum data through an authentic CLI interface.

Tech Stack

Frontend

  • Next.js 16.0.10 - React framework with App Router
  • React 19.2.0 - UI library
  • TypeScript 5 - Type safety and development experience
  • Tailwind CSS 4.1.9 - Utility-first CSS framework

UI Components

  • Radix UI - Accessible component primitives
  • Lucide React - Icon library
  • Recharts - Data visualization
  • React Hook Form - Form management
  • Sonner - Toast notifications

Backend & API

  • Next.js API Routes - Server-side API endpoints
  • Foru.ms API - External forum data integration

Development & Tooling

  • PostCSS - CSS processing
  • Autoprefixer - CSS vendor prefixing
  • ESLint - Code linting
  • Vercel Analytics - Performance monitoring

Installation

  1. Clone the repository

    git clone https://github.com/Asmit1211/v0-cli-forum
    cd v0-cli-forum
  2. Install dependencies

    npm install
  3. Set up environment variables

    cp .env.example .env.local

    Edit .env.local and add your Foru.ms API key:

    FORUMS_API_KEY=your-api-key-here
    
  4. Start the development server

    npm run dev
  5. Open your browser Navigate to http://localhost:3000

Usage & Examples

Basic Commands

Once the application is running, you can use the following CLI commands:

# Show all available commands
help

# List all forum threads
list
ls

# Search for threads
search privacy
search "AI revolution"

# Open a specific thread
open <thread-id>

# Navigate between sections
docs
about
home

# Utility commands
refresh
clear

Navigation Flow

  1. Start - The application displays an ASCII art intro (first visit only)
  2. Terminal Interface - Main CLI interface with command prompt
  3. Browse Threads - Use list to see available discussions
  4. View Threads - Use open <thread-id> to read posts and discussions
  5. Search - Use search <keyword> to find specific topics

Keyboard Shortcuts

  • Ctrl+L - Clear terminal
  • Ctrl+R - Refresh data
  • Arrow keys - Navigate command history

Features

  • Terminal-Style Interface - Authentic CLI experience with command prompt
  • Thread Browsing - List and search forum threads with post counts
  • Thread Viewing - Read complete discussions with user information and timestamps
  • Real-time Data - Live integration with Foru.ms API
  • Search Functionality - Find threads by keywords with fallback mechanisms
  • Responsive Design - Optimized for both desktop and mobile devices
  • Theme Support - Dark terminal theme with customizable colors
  • Command History - Navigate through previously entered commands
  • Error Handling - Graceful fallbacks when API is unavailable
  • Live Statistics - Real-time forum statistics and dashboards
  • Mobile Support - Touch-friendly mobile terminal interface
  • Session Persistence - Remembers active threads and command history

Contributing

  1. Fork the repository

    git fork https://github.com/Asmit1211/v0-cli-forum.git
  2. Create a feature branch

    git checkout -b feature/your-feature-name
  3. Make your changes

    • Follow the existing code style
    • Add TypeScript types for new functionality
    • Test your changes thoroughly
  4. Commit your changes

    git commit -m "Add: your feature description"
  5. Push to your branch

    git push origin feature/your-feature-name
  6. Open a Pull Request

    • Provide a clear description of your changes
    • Include any relevant issue numbers
    • Ensure all tests pass

License

This project is licensed under the MIT License. You are free to use, modify, and distribute this software in accordance with the license terms.

Author & Contact

Asmit Samal GitHub: https://github.com/Asmit1211

For questions, suggestions, or contributions, please open an issue on the GitHub repository or submit a pull request.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors