Skip to content

Commit

Permalink
v1.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sachintha00 committed Jan 26, 2024
2 parents f9a55bb + eb69955 commit 1e1945c
Show file tree
Hide file tree
Showing 8 changed files with 97 additions and 2 deletions.
97 changes: 96 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,96 @@
# Git-manager-npx

# GIT Wizard 🧙✨

GitWizard is your hassle-free companion for seamless Git workflows. Effortlessly manage branching, merging, squashing, releases, and commits with this user-friendly tool. Say goodbye to complexity and embrace a wizardly approach to professional Git workflows for developers.


## ❗️Be careful before use❗️

To ensure compatibility with your Git project, it's important to verify and, if necessary, update the branch name. Start by confirming the current branch name; if it's ```main```, proceed with the update.

Navigate to the ```Settings``` tab of your GitHub repository. Within the ```Repository``` section, locate the ```Default branch``` dropdown. If the current branch is ```main```, modify it to ```master```.

Once you've made this adjustment, scroll down to find the "Save changes" button and apply the update. Your Git project is now configured with the ```master``` branch.

If you encounter any challenges during this process, reference the attached screenshot for visual guidance.

![App Screenshot](./doc/default_branch.png)


## Features 🔥

- Light/dark mode toggle
- Live previews
- Fullscreen mode
- Cross platform


## Installation 🚀

- If you wish to install this into your project, execute the following command:

```bash
npm install git-wizard
```

OR

```bash
npm i git-wizard
```

- For a global installation, utilize the following command:

```bash
npm install -g git-wizard
```

OR

```bash
sudo npm install -g git-wizard
```

- For usage without installation, follow this approach:

```bash
npx git-wizard
```
## How to use❓

- Begin by creating a branch named ```Dev``` based on the ```master``` branch, as illustrated below. Subsequently, push the newly created ```dev``` branch to the origin.

![step 1](https://via.placeholder.com/468x300?text=Step+1)

You can use the following command to create and push the ```dev``` branch to the origin:
```bash
git push --set-upstream origin dev
```

This tool is visible within the ```dev``` branch, as illustrated below.

![step 1](https://via.placeholder.com/468x300?text=Dev+Screenshot)

- To initiate the development of a new feature, it is recommended to create a ```do``` branch off the ```dev``` branch, following the steps below:

![step 1](https://via.placeholder.com/468x300?text=Step+2)

This tool is accessible within the ```do``` branch, as demonstrated below.

![step 1](https://via.placeholder.com/468x300?text=Do+Screenshot)

- To address a bug fix, it is advisable to create a ```fix``` branch based on the ```master``` branch, following the steps outlined below:

![step 1](https://via.placeholder.com/468x300?text=Step+3)

This tool is visible within the ```fix``` branch, as illustrated below.

![step 1](https://via.placeholder.com/468x300?text=Fix+Screenshot)

- Upon executing this in the ```master``` branch, you will encounter a menu resembling the one below.

![step 1](https://via.placeholder.com/468x300?text=Master+Screenshot)
## Author 👽

- [@Sachintha Madhawa](https://www.github.com/sachintha00)

2 changes: 1 addition & 1 deletion app.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import devBranch from './components/dev_branch.js'
import masterBranch from './components/master_branch.js'
import fixBranch from './components/fix_branch.js'

welcomeBanner({ welcomeText: "~GIT WIZARD~", description: "Code Dreams, Build Realities!", versionTag: "v1.0.0" })
welcomeBanner({ welcomeText: "~GIT WIZARD~", description: "Code Dreams, Build Realities!", versionTag: "v1.7.0" })
const branch = await getCurrentGitBranch()
if (branch.startsWith("do")) {
await doBranch()
Expand Down
Binary file added doc/bug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/default_branch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/feature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/fix_merge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/git tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/git_tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1e1945c

Please sign in to comment.