Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #468

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −19
Draft

Update CONTRIBUTING.md #468

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7f1169
Update CONTRIBUTING.md
mshima Jan 30, 2025
7d3986b
Update CONTRIBUTING.md
mshima Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 13 additions & 19 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,16 @@

`cd jhipster-kotlin`

`npm install | yarn`
`npm install`

`npm link | yarn link`
`npm link -g`

( 🏁 Kudos, you just setup JHipster-Kotlin and linked to it locally )

### Step 2 🤟 : before generating your application, go to your application folder

`yarn link "generator-jhipster-kotlin"`

or

`npm link "generator-jhipster-kotlin"`

( 🏁 Kudos, you have done it. It is the time to generate the application `khipster` )

✨✨✨✨ You are rocking ✨✨✨✨

Fix / Code / Document and create a pull request 💯
( 🏁 Kudos, you just setup JHipster-Kotlin and created a global link to khipster executable )

## Generating samples

Create a new folder and generate an application sample using any of the following alternatives.

Default maven application:

```
Expand All @@ -45,7 +33,7 @@ khipster --build gradle --defaults --skip-install
CI samples:

```
khipster generate-sample --app-sample sample-name
khipster generate-sample
```

Tips:
Expand All @@ -54,7 +42,13 @@ Tips:

## Synchronizing generator-jhipster templates

Run:
KHipster templates are convertions of generator-jhipster templates to kotlin.
Templates of both projects are written in [EJS](https://ejs.co/#docs).

KHipster templates are placed inside spring-boot's [templates](https://github.com/jhipster/jhipster-kotlin/tree/main/generators/spring-boot/templates) folder with an hierarchy based on generator-jhipster generators.
KHipster intercepts generator-jhipster writing tasks [replacing java templates with kotlin templates](https://github.com/jhipster/jhipster-kotlin/blob/fa0664034dda3d406dc0d11bff82d4ae1150e838/generators/spring-boot/generator.js#L52-L89).

To make easier to synchronize templates we provide a synchronize dev-blueprint which will place every copy every required template:

```sh
khipster synchronize
Expand Down
Loading