https://github.com/mcruzdev/jbiscoito

JBiscoito is a command-line interface (CLI) designed for effortlessly consuming and generating projects through scaffolding.
https://github.com/mcruzdev/jbiscoito

Last synced: about 1 month ago
JSON representation

JBiscoito is a command-line interface (CLI) designed for effortlessly consuming and generating projects through scaffolding.

• Host: GitHub
• URL: https://github.com/mcruzdev/jbiscoito
• Owner: mcruzdev
• License: apache-2.0
• Created: 2024-01-24T02:54:40.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-14T11:43:49.000Z (6 months ago)
• Last Synced: 2024-05-14T12:47:07.578Z (6 months ago)
• Language: Java
• Size: 38.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# JBiscoito :cookie:

JBiscoito is a command-line interface (CLI) designed for effortlessly consuming and generating projects through scaffolding.

JBiscoito uses Quarkus, [Qute](https://quarkus.io/guides/qute-reference) and Jackson for templating. It is inspered in [Cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.0/index.html) project.

## Getting Started

Download the binary from [release page](https://github.com/mcruzdev/jbiscoito/releases), and configure the binary in your system.

```shell

mv jbiscoito /usr/local/bin/jbiscoito

```

### Creating the jbiscoito.json file

JBiscoito utilizes the `jbiscoito.json` file as a data source for templating with Qute. Execute the following command to create the `jbiscoito.json` file. 

```shell

echo '{"applicationName": "crud", "team": { "name": "crudGroup", "area": "platform"}}' > jbiscoito.json

```

### Running

```shell

jbiscoito [email protected]:mcruzdev/jbiscoito-template.git

```

If you execute `tree jbiscoito-template` command, the output should look something like this:

```shell

jbiscoito-template

├── com

│   └── java

│       └── jbiscoito

│           └── README.md

└── README.md

```

### Installing JBiscoito from source code

1. Clone or fork this repository.

```shell

git clone [email protected]:mcruzdev/jbiscoito.git

```

2. Generate the native image using Quarkus Maven Plugin.

```shell script

./mvnw package -Pnative

```

Move the binary to `jbiscoito`.

```shell

mv target/jbiscoito-1.0.0-SNAPSHOT-runner jbiscoito

```