Skip to content

Commit

Permalink
Merge pull request #2 from cristopher1/development
Browse files Browse the repository at this point in the history
V1.0.1
  • Loading branch information
cristopher1 committed Apr 6, 2024
2 parents 005b1b2 + 8872f16 commit 80db925
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 20 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">Welcome to generator-koa2-api-generator 👋</h1>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
<img alt="Version" src="https://img.shields.io/badge/version-1.0.1-blue.svg?cacheSeconds=2592000" />
<a href="https://github.com/cristopher1/generator-koa2-api-generator#readme" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
Expand Down Expand Up @@ -80,15 +80,15 @@ yo koa2-api-generator koa2_api_project postgresql

The generator-koa2-api-generator include various options, these are:

| option | value | default | description | example |
| :---------------- | :-----: | :-------------------: | :--------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
| runGitInit | Boolean | false | Run git init automatically, then installing the dependencies | `yo koa2-api-generator project_name --runGitInit` |
| runPackageScripts | Boolean | false | Run the scripts that configure the package, then installing the dependencies | `yo koa2-api-generator project_name --runPackageScripts` |
| useDocker | Boolean | false | Add docker support using DockerFile, .dockerignore and others | `yo koa2-api-generator project_name --useDocker` |
| nodeVersion | Number | without default value | Node version used in DockerFile. (FROM nodeVersion). Recommended to use node 16, 18, 20 or 21 | `yo koa2-api-generator project_name --nodeVersion=21` |
| projectFolderName | String | api | Project folder name used in DockerFile. (WORKDIR /usr/src/projectFolderName) | `yo koa2-api-generator project_name --projectFolderName=project_folder_name` |
| useDockerCompose | String | false | Add Docker Compose support. | `yo koa2-api-generator project_name --useDockerCompose` |
| databaseName | String | null | Select the database to which the application will connect. Accepts the values: postgresql, mysql, mariadb. | `yo koa2-api-generator project_name --databaseName=postgresql` |
| option | value | default | description | example |
| :---------------- | :-----: | :-----: | :--------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
| runGitInit | Boolean | false | Run git init automatically, then installing the dependencies | `yo koa2-api-generator project_name --runGitInit` |
| runPackageScripts | Boolean | false | Run the scripts that configure the package, then installing the dependencies | `yo koa2-api-generator project_name --runPackageScripts` |
| useDocker | Boolean | false | Add docker support using DockerFile, .dockerignore and others | `yo koa2-api-generator project_name --useDocker` |
| nodeVersion | Number | 16 | Node version used in DockerFile. (FROM nodeVersion). Recommended to use node 16, 18, 20 or 21 | `yo koa2-api-generator project_name --nodeVersion=21` |
| projectFolderName | String | api | Project folder name used in DockerFile. (WORKDIR /usr/src/projectFolderName) | `yo koa2-api-generator project_name --projectFolderName=project_folder_name` |
| useDockerCompose | String | false | Add Docker Compose support. | `yo koa2-api-generator project_name --useDockerCompose` |
| databaseName | String | null | Select the database to which the application will connect. Accepts the values: postgresql, mysql, mariadb. | `yo koa2-api-generator project_name --databaseName=postgresql` |

## <a id="structure"></a> Project structure

Expand Down
5 changes: 5 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Yeoman generator that creates a base structure to create APIs in koa2 with sequelize and others tools.

**Feature added in version 1.0.1:**

- Removed @babel/plugin-transform-runtime from api/babel.config.json
- Adds in documentation default value for nodeVersion in docker generator (node version 16)

**Features added in version 1.0.0:**

- generator-koa2-api-generator only include configurations for development environment.
Expand Down
7 changes: 0 additions & 7 deletions generators/babel/templates/api/babel.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@
"presets": [["@babel/preset-env", { "targets": { "node": "current" } }]],
"comments": true,
"plugins": [
[
"@babel/plugin-transform-runtime",
{
"corejs": 3,
"version": "^7.22.15"
}
],
"babel-plugin-transform-import-meta",
"babel-plugin-add-module-exports"
]
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-koa2-api-generator",
"version": "1.0.0",
"version": "1.0.1",
"description": "Yeoman generator to create a base structure for APIs based in koa2 framework and sequelize, using tools such as: eslint, prettier, swagger and others",
"homepage": "https://github.com/cristopher1/generator-koa2-api-generator",
"type": "module",
Expand Down

0 comments on commit 80db925

Please sign in to comment.