Skip to content

Initial cookiecutter #2

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.

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

Merged
merged 5 commits into from
Nov 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions .github/workflows/scaffold.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Generate
on:
pull_request:
branches: [ main ]
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v5
with:
python-version: '3.9'
- uses: actions/cache@v4
id: pip-cache
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-
restore-keys: |
${{ runner.os }}-pip-
- name: Install cookiecutter
run: |
pip install cookiecutter
# - name: Test cookiecutter
# run: |
# cookiecutter . --no-input
# - name: Set up JDK 21
# uses: actions/setup-java@v1
# with:
# java-version: 21
# - name: Cache Maven packages
# uses: actions/cache@v2
# with:
# path: ~/.m2
# key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
# restore-keys: ${{ runner.os }}-m2
# - name: Build with Maven
# run: cd sample && mvn clean install -ntp
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# IntelliJ project files
.idea
*.iml
out
gen

# The default sample project
sample
5 changes: 5 additions & 0 deletions cookiecutter.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"app_name": "sample",
"app_name_lower": "{{cookiecutter.app_name.lower()}}",
"app_title": "{{cookiecutter.app_name.capitalize()}}"
}
Empty file removed docs/.nojekyll
Empty file.
87 changes: 0 additions & 87 deletions docs/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/_coverpage.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_sidebar.md

This file was deleted.

81 changes: 0 additions & 81 deletions docs/index.html

This file was deleted.

51 changes: 51 additions & 0 deletions {{cookiecutter.app_name_lower}}/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# {{cookiecutter.app_title}}

## Pre-requisite

- maven >= 3.8.6
- open jdk 21

## How to build ?

```
mvn clean install
```

### How to build a docker image ?

```
cd bootstrap && mvn compile jib:dockerBuild
```

[More information](https://cloud.google.com/java/getting-started/jib)

## How to start ?

```
cd bootstrap && mvn spring-boot:run
```

## Formatting

This project uses [git-code-format-maven-plugin](https://github.com/Cosium/git-code-format-maven-plugin) for formatting
the code per [google style guide](https://google.github.io/styleguide/javaguide.html)

### How to format ?

`mvn git-code-format:format-code`

## Validating

This project uses [githook-maven-plugin](https://mvnrepository.com/artifact/io.github.phillipuniverse/githook-maven-plugin) which is a maven plugin to configure and install local git hooks by running set of commands during build.

### Command to validate formatted code

```
mvn git-code-format:validate-code-format
```

## Contribution guidelines

We are really glad you're reading this, because we need volunteer developers to help this project come to fruition.

Request you to please read our [contribution guidelines](https://devs-from-matrix.github.io/basic-template-repository/#/README?id=contribution-guidelines)
Loading