Gabum

A simple project manager made with Node JS.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • 1.1. Built With
2. Getting Started
   • 2.1. Prerequisites
   • 2.2. Installation
3. Usage
   • 3.1. Create a new project
   • 3.2. Open a project
   • 3.3. Get additional help
   • 3.4. Other Commands
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A simple project manager made with Node JS. Currently in the form of CLI, soon in the form of an Electron application offering voice recognition.

(back to top)

Built With

• Oclif
• TypeScript
• NodeJS
• Yaml

(back to top)

Getting Started

Here are the simple steps to install and use gabum:

Prerequisites

Gabum needs some other softwares to work. Here is a list of them and where to install them.

• nodejs: Okay, it's basically the runner of the code
• yarn: Just a NodeJs Package Manager like npm. You can use another if you want.
• git: You should probably already have it installed, it's usefull to push your code to github.
• gh: The official cli of githyb, usefull to create repository remotely

Installation

Install CLI with yarn

yarn global add gabum

Or with npm (no judgments)

npm install -g gabum

(back to top)

Usage

Create a new project

$ gabum project create
Follow the instructions

Open a project

$ gabum project open
Follow the instructions
$ gabum open My-Super-Project --with ide
Opening project in VSCode, for example

Get additional help

$ gabum --help [COMMAND]
USAGE
  $ gabum COMMAND
...

Other commands

I'll yet Oclif explain you how the other commands work.

• gabum config - Configure Gabum CLI
• gabum help - Display help for gabum.
• gabum project - Project Management
• gabum test - Test command
• gabum upgrade - upgrade the package to the last version
• gabum which - Show which plugin a command is in.

(back to top)

Roadmap

• Project Creation
• Open Project
• Use a New Readme Template (like in templates)
• Configuration
  • New Config Manager
  • Config Hook
  • Config Command
  • Implementation
• Base Command
  • Logger
  • Config wrapper
  • Prompt Wrapper
  • Implementation
• Template Definitions
  • List
  • Prompter
• Project Definitions Storage
  • In User Configs
  • In Project
• Delete Command
• More Templates
  • Blank
  • Simple JS
  • Simple TS
  • Rust Binary Package
  • Rust Library Package
  • Discord JS
  • Discord TS
  • CLI JS
  • CLI TS
  • CLI Oclif
  • API JS
  • API TS
  • API Adonis
  • Website
  • VueJs
  • ReactJs
  • Find Ideas
• Some Coding Tools
  • Line Counter
  • Publish Command
  • Readme Generator
  • Find Ideas
• Electron App
• Voice Recognition

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

More infos in CONTRIBUTING.md

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Galitan - @Galitan33 - galitan.dev@google.com

Discord: Send me a private message - Join my server

Project Link: https://github.com/Galitan-dev/Gabum

(back to top)

Acknowledgments

• Progress Bar Generator - CC0 - Public Domain
• Raraph84 for just being a friend

(back to top)