Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hitesh22rana/bashcraft

BASHcraft, your home for mastering BASH scripting! ๐Ÿš€
https://github.com/hitesh22rana/bashcraft

automation bash bash-script learning learning-by-doing open-source shell-scripting unix

Last synced: 14 days ago
JSON representation

BASHcraft, your home for mastering BASH scripting! ๐Ÿš€

Awesome Lists containing this project

README

        

# ๐Ÿš€ BASHcraft

Welcome to BASHcraft! ๐ŸŽ‰ your ultimate destination to master the art of BASH scripting! Whether you're a command-line novice or a seasoned shell warrior, โš”๏ธ BASHcraft is your gateway to scripting wizardry.๐Ÿง™ Dive into our structured classes, harness the power of BASH, and automate like a pro. Get ready to level up your Unix-like system skills with us!๐Ÿš€

![Bash Logo](https://bashlogo.com/img/symbol/png/full_colored_dark.png)

## ๐Ÿ“š Table of Contents

1. [Getting Started](#getting-started)
2. [Prerequisites](#prerequisites)
3. [About BASH](#about-bash)
4. [Class Structure](#class-structure)
5. [Automate with `make.sh`](#automate-with-makesh)
6. [Contributing](#contributing)

## Getting Started

Ready to embark on your BASH adventure? Let's kick things off! ๐Ÿ”ฅ

1. Clone this repository to your local machine:

```bash
git clone https://github.com/hitesh22rana/BASHcraft
```

2. Navigate to the repository directory:

```bash
cd BASHcraft
```

3. Dive into the first class by checking out the `class01/` directory. ๐Ÿ“–

## Prerequisites

Before we set sail, let's make sure you've got your gear ready:

- Basic knowledge of the Unix/Linux command line. ๐Ÿง
- A text editor (e.g., Vim, Nano, VSCode) installed and ready to roll. โœ๏ธ
- A Unix-like environment (Linux, macOS, or Windows with WSL) to flex your BASH muscles. ๐Ÿ’ช

## About BASH

BASH is not just a shell; it's your command-line companion, your automation buddy, and your key to unlocking the full potential of your Unix-like system. ๐Ÿค–

## Class Structure

Our BASH class is structured to make learning a breeze. Each class is a stepping stone in your BASH journey:

- `class01/`: Hello World ๐ŸŒ
- `class02/`: BASH Variables ๐Ÿ’ผ
- `class03/`: Math with Bash โž•โž–
- `class04/`: If statements โ“โ—

In each class directory, you'll find documentation and examples to help you grasp the concepts covered. ๐ŸŽ“

## Automate with `make.sh`

Introducing our secret weapon: `make.sh`! This nifty script is here to streamline your project setup with docstrings.

### ๐Ÿ—๏ธ How to Use `make.sh`

1. Open your terminal and navigate to the repository root.

2. Execute the following command to wield the power of `make.sh`:

```bash
./make.sh -f -d ""
```

- Replace `` with your desired directory name.
- Replace `` with a brief description or docstring for your script (enclose it in double quotes if it's got spaces).

3. Boom! ๐Ÿงจ The script will conjure your directory and a `script.sh` file within. Your docstring is ready and waiting.

4. Customize the `script.sh` to your heart's content for your project.

**Example:**

```bash
./make.sh -f my_project -d "This script will conquer the world!"
```

This command creates a directory named `my_project` with the docstring you provided.

### ๐Ÿ› ๏ธ Additional Information

- The script also grants superpowers to `script.sh` by making it executable with `chmod +x`.
- Feel free to tweak `make.sh` to fit your unique needs, like changing the default file name or permissions.

Enjoy the magic of the automated directory structure generator script! โœจ

## Contributing

Join our BASH-tastic community! Contributions are not just welcome; they're celebrated! If you spot issues, have brilliant ideas, or want to add more awesomeness, open an issue or send a pull request. Let's make BASH even more fantastic together!

Happy BASH scripting!๐Ÿ”ฅ