Bash Bits Monorepo v-1.0.0

Central Repository for ALL Bash Bits Modules

Issues 🔹 Documentation 🔹 Releases

⭐ Project Overview

This monorepo brings together all of the Bash Bits Modules in one central place (you can find the modules in the submodules directory. Arguably, the most important of these is the BB-Installer Module, which provides the means by which you can install the Bash Bits modules on your own environment, and from there make them a part of your own projects.

^ Top

❓ What's Included?

The current registry of Bash Bits Modules includes:

• ✅ BB-Installer Module
• ✅ BB-Common Module
• ✅ BB-Logger Module
• ✅ BB-Dotfiles Module
• ✅ BB-Template Module

^ Top

📂 Installation

To execute the remote installer, cut-and-paste the following line of code into your terminal window:

sudo su -c "bash <(wget -O- https://raw.githubusercontent.com/bash-bits/bb-installer/master/remote.sh)" root

This will first download the BB-Installer Module Repository to your local machine and save it in a temporary directory. From there, to install the entire project automatically, execute the following commands:

cd /tmp/bb-installer
sudo bash install.sh

The module installer accepts a range of arguments which allow you to customise your installation.

The following command will install only version 1.1.0 of the BB-Common Module:

sudo bash install.sh --module='bb-common' --version='1.1.0'

The module installer is also responsible for updating and uninstalling the project:

sudo bash install.sh --process='update'

sudo bash install.sh --process='uninstall'

^ Top

🚧 Author / Maintainer

Created with ☕ by Ragdata

^ Top

🔐 Security

While the Bash Bits project follows good security practices, 100% security can never be guaranteed in any software package. The Bash Bits Monorepo is provided AS IS, and without warranty. You can find more details in the LICENSE file included with this repository.

If you discover any issue regarding the security of this project, please disclose that information responsibly by sending a security advisory. PLEASE DO NOT CREATE AN ISSUE OR DISCUSSION TOPIC. You can read more about this project's security policies HERE

^ Top

💪 Available Support

^ Top

💎 Contributors

If you'd like to make a contribution, then please see the Bash Bits Contributor's Guide

It's not just contributions of code that I'm looking for. If you have any ideas or suggestions about how this project may be improved, don't hesitate to open an issue and let me know! Contributions of ALL kinds will be recognised here if they are made part of this project - thanks to the All-Contributors bot.

VIEW PROJECT CONTRIBUTORS

^ Top

👍 Supporting the Project

The creation and maintenance of Open Source Software is definitely a labour of love - this is never going to be a path to riches. The truth is, it takes not only a lot of time, it creates a substantial amount of personal expense (even when you're working on a shoestring) to keep these projects freely available for all.

If you'd like more info about how you can help out, head to my Sponsor's Page

^ Top

©️ Copyright & Attributions

This project incorporates ideas and / or code crafted by the following talented individuals:

"We see much further, and reach much higher,
only because we stand upon the shoulders of giants"

^ Top

⚖️ License

MIT License

Copyright © 2022-2023 Darren (Ragdata) Poulton

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

^ Top

📖 Resources

Used by Bash Bits

• reconquest/shdoc
• reconquest/tests.sh

<< MORE BASH RESOURCES HERE >>

^ Top

⭐ Star This Repo

!! SUPPORT THIS PROJECT !!

It doesn't have to be a lot, but you will magnify your contribution if you're able to give a little every month. If you're not in a position to do that, but think you could make a small, one-time donation to the kitty - you'd be AMAZED how I can make a little go a LONG way!

EVERY financial supporter gets their name associated with the project.

Find out more on my Sponsor's Page

^ Top