Skip to content

braymonz/brewfinder

Repository files navigation

Brewfinder Logo

Website GitHub Issues or Pull Requests GitHub Issues or Pull Requests

📎 Content

📋 Overview

Brewfinder is a modern web application designed to simplify the discovery and management of Homebrew packages. It provides a user-friendly interface for searching, organizing, and installing packages from the Homebrew package manager, which is widely used specially on macOS but also available for Linux, and Windows (via WSL).

Whether you're a developer setting up a new environment, a data scientist managing dependencies, or a system administrator maintaining multiple machines, Brewfinder helps you create, share, and reuse package collections for consistent installations across your systems.

✨ Features

Package Discovery

  • Search & Browse: Find packages by name, description, or category
  • Detailed Information: View comprehensive package details, dependencies, and installation statistics
  • Analytics: Explore trending and popular packages with visual charts

List Management

  • Create Custom Lists: Group packages for different development environments or projects
  • Save & Share: Save lists to your profile and share them with the community
  • Like & Discover: Find and like useful lists created by other users

Installation Helpers

  • Installation Scripts: Generate ready-to-use installation scripts for your package lists
  • Copy Commands: Easily copy installation commands for individual packages

Community Features

  • Public Lists: Discover curated package collections from the community
  • Feature Requests: Submit and vote on new feature ideas for Brewfinder
  • Roadmap: View upcoming features and development plans

🚀 Installation

Prerequisites

  • Node.js
  • npm, pnpm, yarn or any other Node.js package manager
  • Git

Setup

  1. Clone the repository:
git clone https://github.com/bhyxen/brewfinder.git
cd brewfinder
  1. Install dependencies:
pnpm install
# or
yarn install
  1. Set up environment variables:
cp .env.example .env.local

Edit .env.local with your configuration values.

  1. Start the development server:
pnpm run dev
# or
yarn dev
  1. Open http://localhost:3000 in your browser.

🛠️ Tech Stack

  • Frontend: Next.js, React, TypeScript, Tailwind CSS
  • UI Components: shadcn/ui, Lucide React icons, react-simple-icons
  • Data Visualization: Recharts
  • Authentication: Auth.js
  • API: Next.js API Routes
  • Database: MongoDB and Redis

🗺️ Roadmap

Our development roadmap is available on the Roadmap page of the application.

👥 Contributing

We welcome contributions from the community! Here's how you can help:

  1. Report Bugs: Submit issues for any bugs you encounter
  2. Suggest Features: Have an idea? Submit a feature request
  3. Submit PRs: Want to fix a bug or add a feature? Submit a pull request

Development Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes using conventional commits: git commit -m 'feat: add amazing feature'
  4. Push to the branch in your forked repository: git push origin feature/amazing-feature
  5. Open a Pull Request

🙏 Acknowledgments

Releases

No releases published

Packages

No packages published