Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dansholds/brewfiles
A Community Collective of Role Specific Brewfiles 🍺
https://github.com/dansholds/brewfiles
brew brewfile developer-tools development development-environment
Last synced: about 2 months ago
JSON representation
A Community Collective of Role Specific Brewfiles 🍺
- Host: GitHub
- URL: https://github.com/dansholds/brewfiles
- Owner: dansholds
- License: mit
- Created: 2024-05-22T09:30:51.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-25T07:21:40.000Z (9 months ago)
- Last Synced: 2024-12-08T06:05:31.634Z (2 months ago)
- Topics: brew, brewfile, developer-tools, development, development-environment
- Language: Ruby
- Homepage: https://brewfiles.dev
- Size: 29.3 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Brewfiles
[](https://brew.sh/)
[](https://peerlist.io/grapplingdev)
Welcome to the **Brewfiles Repository**! This is a community-driven project where users can share their `Brewfile` configurations. By contributing to this repository, you can help others quickly set up their macOS or Linux environments with Homebrew.
---
## 🚀 What is a Brewfile?
A `Brewfile` is a convenient way to describe the setup of your Homebrew packages, casks, and taps. It allows you to install all your dependencies with a single command. This is particularly useful for setting up a new machine or sharing your development environment with others.
---
## 📦 How to Use a Brewfile
1. **Clone the Repository**:
```sh
git clone https://github.com/dansholds/brewfiles.git
cd brewfiles
```
2. **Choose a Brewfile**:
Browse through the available `Brewfile`s in the repository and select one that suits your needs.
3. **Install Packages**:
Use the `brew bundle` command to install the packages listed in the selected `Brewfile`:
```sh
brew bundle --file=path/to/Brewfile
```
---
## 🤝 How to Contribute
We welcome contributions from the community! Follow these steps to add your `Brewfile` to the repository:
1. **Fork the Repository**:
Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.
2. **Clone Your Fork**:
```sh
git clone https://github.com//brewfiles.git
cd brewfiles
```
3. **Create a New Branch**:
```sh
git checkout -b your-branch-name
```
4. **Create your Brewfile**
```sh
brew bundle dump --file=Brewfile
```
5. **Add Your Brewfile**:
Place your `Brewfile` in a new directory named after the main purpose or the environment it sets up, for example, `web-development/Brewfile` or `data-science/Brewfile`.
If the purpose or environment already exists, use something that makes it unique.
6. **Commit Your Changes**:
```sh
git add .
git commit -m "Add Brewfile for [describe environment]"
```
7. **Push to Your Fork**:
```sh
git push origin your-branch-name
```
8. **Create a Pull Request**:
Go to your fork on GitHub, and you should see a "Compare & pull request" button. Click it and submit your pull request.
---
## 📁 Directory Structure
Please follow this directory structure when adding your Brewfile:
```
brewfiles/
├── README.md
├── /
│ └── GitHub Username (i.e, dansholds)
| └── Brewfile
```
Examples of categories include:
- `web-development`
- `data-science`
- `machine-learning`
- `devops`
- `design`
---
## 📜 License
This repository is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
---
## 📞 Contact
If you have any questions or suggestions, feel free to open an issue or contact the repository maintainers.
Happy brewing! 🍻