@anthonylzq/simba.js 7.2.1 → 8.1.0

package/README.md

@@ -8,8 +8,7 @@
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnthonyLzq/simba.js/blob/master/LICENSE)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
-[![Lint](https://github.com/AnthonyLzq/simba.js/actions/workflows/lint.yml/badge.svg)](https://github.com/AnthonyLzq/simba.js/actions/workflows/lint.yml)
-[![Tests for Simba APIs](https://github.com/AnthonyLzq/simba.js/actions/workflows/test.yml/badge.svg)](https://github.com/AnthonyLzq/simba.js/actions/workflows/test.yml)
+[![Publish](https://github.com/AnthonyLzq/TypeScriptProjectGenerator/actions/workflows/publish.yml/badge.svg)](https://github.com/AnthonyLzq/TypeScriptProjectGenerator/actions/workflows/publish.yml)
 
 Set up a modern backend app by running one command. This project has the goal to create a complete setup for a backend application using `TypeScript` and `Express` or `Fastify`. It will create many files that are usually created manually. Think about Simba.js like a [CRA](https://create-react-app.dev/), but for backend development. Check the [**project structure**](#project-structure) for more information.
 
@@ -31,19 +30,18 @@ simba -q
 
 By doing this your prompt will ask you the following questions:
 
-- `Yarn or npm?`, only one of them is valid (lowercase).
-- `Express or Fastify?`, only one of them is valid (lowercase).
-- `Project name:`, at least one character must be provided.
+- `Project name?`, at least one character must be provided.
 - `Project description:`, at least one character must be provided.
+- `Select your package manager`, `npm`, `yarn` and `pnpm` are available.
 - `Author:`, at least one character must be provided.
 - `Email:`, a correct email address must be provided.
-- `Project version (0.1.0):` the initial version of the project, `0.1.0` as default.
-- `Select your license [1...7]:`, the license you have chosen for the project.
+- `Project version:` the initial version of the project, `0.1.0` as default.
+- `License:`, the license you have chosen for the project.
 - `License year (current year):`, the year where your license starts, current year as default.
-- `Will this project use GraphQL? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
-- `Will this project be deployed with Heroku? [y/n]:`.
-- `Would you want to have a basic suit of tests with Jest? [y/n]:`.
 - `Would you want to have a basic GitHub Action for the suit of tests and linting? [y/n]:`.
+- `Express or Fastify?`, only one of them is valid (lowercase).
+- `Will this project use GraphQL? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
+- `Which database do you want to use?`, `MongoDB`, `PostgreSQL`, `MySQL`, `MariaDB`, `Sqlite` and `Microsoft SQL Server` are available.
 
 The second option you have is by passing flags in one single command. If you need help, please run:
 
@@ -54,24 +52,26 @@ simba -h
 This will generate the following output:
 
 ```bash
-"simba [options]" (if you it installed globally) or only "simba -q" if you want
-to be asked for the options one by one.
+Simba.js, the easiest way to create your TypeScript APIs
+
+Usage:
+"simba [options]" or only "simba -q" if you want to be asked for the options one
+by one.
 
 Options:
   -N, --projectName              Project name.
   -D, --projectDescription       Project description.
   -a, --author                   Author of the project.
   -e, --email                    Email of the author.
-  -H, --heroku                   Whether or not the project will be deployed
-                                 using Heroku.        [boolean] [default: false]
   -l, --license                  Type of license for the project, it can be one
                                  of: MIT, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0
                                  and AGPL 3.0, in lowercase without its version.
                                                          [default: "unlicensed"]
   -v, --version                  Project initial version.     [default: "0.1.0"]
-  -y, --licenseYear              Year when the license starts. [default: "2022"]
-  -n, --npm                      Whether or not the project should use npm as
-                                 package manager.     [boolean] [default: false]
+  -y, --licenseYear              Year when the license starts. [default: "2023"]
+  -m, --manager                  Which package manager you want to use,
+                                 available package managers are: npm, yarn and
+                                 pnpm.                         [default: "pnpm"]
   -f, --mainFile                 Main file of the project.
                                                        [default: "src/index.ts"]
   -q, --questions                Whether or not you want to be asked to answer
@@ -81,16 +81,15 @@ Options:
                                  project.             [boolean] [default: false]
   -g, --graphql                  Whether or not you want to use GraphQL for your
                                  project.             [boolean] [default: false]
-  -t, --tests                    Whether or not you want to have a basic suit of
-                                 unit tests with Jest.[boolean] [default: false]
       --ghat, --gh-action-tests  Whether or not you want to have a GitHub Action
                                  with a CI for your tests and linting. If this
                                  option is set to true, the tests flag must be
                                  set to true.                   [default: false]
   -d, --database                 Which database you want to use, available
-                                 databases are: MongoDB, PostgreSQL, MySQL,
-                                 MariaDB, Sqlite and Microsoft SQL Server.
-                                                              [default: "mongo"]
+                                 databases are: MongoDB (mongo), PostgreSQL
+                                 (postgres), MySQL (mysql), MariaDB (mariadb),
+                                 Sqlite (sqlite) and Microsoft SQL Server
+                                 (sqlServer).                 [default: "mongo"]
   -h, --help                     Show help                             [boolean]
 
 Examples:
@@ -110,10 +109,10 @@ simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H
 
 Here we are specifying that we want to create a new project called `myProject` using the `MIT` license, my name and my email are respectively: `myName` and `myEmail@email.com` and I want to use heroku to deploy this server.
 
-As default, `yarn` is selected as package manager, but if you don't want to use it, you can pass the flag `-n` or `--npm` as follows:
+As default, `pnpm` is selected as package manager, but if you don't want to use it, you can pass the flag `-m` or `--manager` as follows:
 
 ```bash
-simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -n
+simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -m yarn
 ```
 
 What if I want to use Fastify instead Express? Well, you only have to pass the `-F` flag:
@@ -125,9 +124,17 @@ simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H
 If I want to use a relational database instead MongoDB? Well, you only have to pass the `-d` flag:
 
 ```bash
-simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -F -d postgresql
+simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -F -d postgres
 ```
 
+The available databases are:
+  - `MongoDB` (_mongo_)
+  - `PostgreSQL` (_postgres_)
+  - `MySQL` (_mysql_)
+  - `MariaDB` (_mariadb_)
+  - `Sqlite` (_sqlite_)
+  - `Microsoft SQL Server` (_sqlServer_).
+
 And how can I use GraphQL? Well, you only have to pass the `-g` flag:
 
 ```bash
@@ -140,33 +147,31 @@ Finally, you may not want to use a license or one of the available licenses, don
 simba -N myProject -D 'This is a test' -a myName -e myEmail@email.com -H
 ```
 
-#### Why I didn't you use [`TypeGraphQL`](https://typegraphql.com/)?
-
-[They don't support GraphQL v16.x.x](https://github.com/MichalLytek/type-graphql/issues/1100), until then.
-
 ## <a name="project-structure"></a>Project structure
 
 If you want to check the content of the files, please check the [example](https://github.com/AnthonyLzq/simba.js/tree/master/example) folder, there you will an example for both, Express and Fastify (REST and GraphQL versions). Regardless of the option chosen, a new folder will be generated with the name of the project.
 
 Also, if you are interested in the folder structure of each case, please take a look at:
 
-- [Express case](./projectStructureExamples/express.txt)
-- [Express-GraphQL case](./projectStructureExamples/express-graphql.txt)
-- [Express-GraphQL-Sequelize case](./projectStructureExamples/express-GraphQL-sequelize.txt)
-- [Express-Sequelize case](./projectStructureExamples/express-sequelize.txt)
-- [Fastify case](./projectStructureExamples/fastify.txt)
-- [Fastify-GraphQL case](./projectStructureExamples/fastify-graphql.txt)
-- [Fastify-GraphQL-Sequelize case](./projectStructureExamples/fastify-graphql-sequelize.txt)
-- [Fastify-Sequelize case](./projectStructureExamples/fastify-sequelize.txt)
+- [Express](./projectStructureExamples/express.txt)
+- [Express-GraphQL](./projectStructureExamples/express-graphql.txt)
+- [Express-Mongo](./projectStructureExamples/express-mongo.txt)
+- [Express-Mongo-GraphQL](./projectStructureExamples/express-mongo-graphql.txt)
+- [Fastify](./projectStructureExamples/fastify.txt)
+- [Fastify-GraphQL](./projectStructureExamples/fastify-graphql.txt)
+- [Fastify-Mongo](./projectStructureExamples/fastify-mongo.txt)
+- [Fastify-Mongo-GraphQL](./projectStructureExamples/fastify-mongo-graphql.txt)
 
 ### Some considerations
 
 - You are able to run a server that has one main route, `home` (`/`), `user` (`api/user` or `api/user/:id`) and `docs` (`api/docs`), in case you are not using GraphQL.
-- In case you are using GraphQL, there are 4 mutations (`storeUser`, `updateUser`, `deleteAllUsers` and `deleteUser`) and 2 queries available (`getUsers` and `getUser`), you can find them in the playground under the route `/api`.
-- To connect your server with your `MongoDB` database, you need to provide your `uri` in the `.env`. By default, Simba will try to connect to a local database. The content of the `.env` file is:
+- In case you are using GraphQL, there are 3 mutations (`store`, `update`, and `deleteById`) and 1 query available (`getById`), you can find them in the playground under the route `/api`.
+- To connect your server with your database, you need to provide your database url in the `.env`, except if you choose `sqlite`. By default, Simba will try to connect to a local database. The content of the `.env` file is:
 
   ```bash
-  MONGO_URI = mongodb://mongo:mongo@mongo:27017/${projectName}
+  DATABASE_URL = mongodb://mongo:mongo@mongo:27017/${projectName} # in case you choose mongo
+  # or
+  DATABASE_URL = postgres://postgres:postgres@postgres:5432/${projectName} # in case you choose postgres
   ```
 
   Where `${projectName}` will be replaced by the name of the project you provided in lowercase.
@@ -199,49 +204,54 @@ Also, if you are interested in the folder structure of each case, please take a
 - If you provide a project name that contains spaces, something like 'My awesome Project',  every space will be replaced with a hyphen. So at the end your project name will be 'My-awesome-project', but in its README.md file, the hyphens will be removed and the project name will be parsed to title case (My Awesome Project).
 - Finally, `git` will be initialized and a list of libraries will be installed. Check the [**notes**](#notes).
 - Relative imports is already configured, you do not need to import a file using `../../../some/very/nested/stuff/in/other/folder`, you can use `some/very/nested/stuff/in/other/folder` assuming that your folder is under the `src` folder.
-- The Fastify version is set to v3 because Apollo Server has not yet provided support for Fastify v4 yet, and it is difficult to have support for two different major versions of Fastify, so until Apollo Server supports Fastify v4, this package will use Fastify v3.
-- Support for Heroku will be deprecated in the next major release because it drops its free tier.
 
 ## Who uses Simba.js?
 
-<p align="left" style="display: flex; align-items: center;">
-  <a href="https://chazki.com/">
-    <img
-      width="272"
-      src="https://i.ibb.co/3kbN6gG/logo-chazki-blanco-250px.png"
-      alt="Simba.js"
-    >
-  </a>
-  <a href="https://www.mein.ai">
-    <img
-      width="269"
-      src="https://static.wixstatic.com/media/e61b06_ed2d347ea1a44effa5a912e7d4fdd9a2~mv2.png/v1/fill/w_269,h_64,al_c,q_85,usm_0.66_1.00_0.01,enc_auto/logoMein.png"
-      alt="Simba.js"
-    >
-  </a>
-</p>
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://chazki.com">
+        <img src="https://i.ibb.co/3kbN6gG/logo-chazki-blanco-250px.png" width="160" />
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://www.mein.ai">
+        <img src="https://static.wixstatic.com/media/e61b06_ed2d347ea1a44effa5a912e7d4fdd9a2~mv2.png/v1/fill/w_269,h_64,al_c,q_85,usm_0.66_1.00_0.01,enc_auto/logoMein.png" width="160" />
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://www.securitec.pe">
+        <img src="https://securitec.pe/LogoBlanco.svg" width="160" />
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">Chazki</td>
+    <td align="center">Mein</td>
+    <td align="center">Securitec</td>
+  </tr>
+</table>
+
 
 ## What is new?
 
 Please check the [`changelog.md`](https://github.com/AnthonyLzq/simba.js/blob/master/CHANGELOG.md) file. Also, if you want to check what is coming, check the [road map](https://simbajs.notion.site/simbajs/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df).
 
-### Version 6.x.x
-
-In this major version I would be focusing on adding integrations for CI/CD and testing.
-
 ## <a name="notes"></a>Notes
 
 Here is the list of the packages that are being installed, as `dependencies`:
 
-- [`@sinclair/typebox`](https://www.npmjs.com/package/@sinclair/typebox)
-- [`ajv`](https://www.npmjs.com/package/ajv)
+- [`debug`](https://www.npmjs.com/package/debug)
+- [`zod`](https://www.npmjs.com/package/zod)
 - [`http-errors`](https://www.npmjs.com/package/http-errors)
-- [`mongoose`](https://mongoosejs.com/)
-- [`pino-pretty`](https://www.npmjs.com/package/pino-pretty)
+- [`@prisma/client`](https://www.npmjs.com/package/@prisma/client)
 
 As `devDependencies`:
 
+- [`@jest/types`](https://www.npmjs.com/package/@jest/types)
+- [`@types/debug`](https://www.npmjs.com/package/@types/debug)
 - [`@types/http-errors`](https://www.npmjs.com/package/@types/http-errors)
+- [`@types/jest`](https://www.npmjs.com/package/@types/jest)
 - [`@types/node`](https://www.npmjs.com/package/@types/node)
 - [`@typescript-eslint/eslint-plugin`](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
 - [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
@@ -251,38 +261,31 @@ As `devDependencies`:
 - [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)
 - [`eslint-config-standard`](https://www.npmjs.com/package/eslint-config-standard)
 - [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import)
+- [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest)
 - [`eslint-plugin-n`](https://www.npmjs.com/package/eslint-plugin-n) (in case you are using yarn as package manager)
+- [`eslint-plugin-node`](https://www.npmjs.com/package/eslint-plugin-node)
 - [`eslint-plugin-prettier`](https://www.npmjs.com/package/eslint-plugin-prettier)
+- [`eslint-plugin-promise`](https://www.npmjs.com/package/eslint-plugin-promise)
+- [`jest`](https://www.npmjs.com/package/jest)
+- [`jest-unit`](https://www.npmjs.com/package/jest-unit)
 - [`nodemon`](https://www.npmjs.com/package/nodemon)
 - [`prettier`](https://www.npmjs.com/package/prettier)
+- [`prisma`](https://www.npmjs.com/package/prisma)
 - [`standard-version`](https://www.npmjs.com/package/standard-version)
 - [`ts-loader`](https://www.npmjs.com/package/ts-loader)
 - [`ts-node`](https://www.npmjs.com/package/ts-node)
 - [`tsconfig-paths`](https://www.npmjs.com/package/tsconfig-paths)
-- [`tsconfig-paths-webpack-plugin`](https://www.npmjs.com/package/tsconfig-paths-webpack-plugin)
+- [`ts-jest`](https://www.npmjs.com/package/ts-jest)
 - [`typescript`](https://www.npmjs.com/package/typescript)
-- [`webpack`](https://www.npmjs.com/package/webpack)
-- [`webpack-cli`](https://www.npmjs.com/package/webpack-cli)
-- [`webpack-node-externals`](https://www.npmjs.com/package/webpack-node-externals)
 
 ### In case you are using GraphQL
 
 As `dependencies`:
-- [`@graphql-tools/schema`](https://www.npmjs.com/package/@graphql-tools/schema)
-- [`ajv`](https://www.npmjs.com/package/ajv)
-- [`ajv-formats`](https://www.npmjs.com/package/ajv-formats)
-- [`apollo-server-core`](https://www.npmjs.com/package/apollo-server-core)
+- [`@apollo/server`](https://www.npmjs.com/package/@apollo/server)
+- [`class-validator`](https://www.npmjs.com/package/class-validator)
 - [`graphql`](https://www.npmjs.com/package/graphql)
-
-### In case you added a suit of tests:
-
-As `devDependencies`:
-- [`@jest/types`](https://www.npmjs.com/package/@jest/types)
-- [`@types/jest`](https://www.npmjs.com/package/@types/jest)
-- [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest)
-- [`jest`](https://www.npmjs.com/package/jest)
-- [`jest-unit`](https://www.npmjs.com/package/jest-unit)
-- [`ts-jest`](https://www.npmjs.com/package/ts-jest)
+- [`reflect-metadata`](https://www.npmjs.com/package/reflect-metadata)
+- [`type-graphql`](https://www.npmjs.com/package/type-graphql/v/2.0.0-beta.2)
 
 ### Express case
 
@@ -290,44 +293,29 @@ As `dependencies`:
 
 - [`cors`](https://www.npmjs.com/package/cors)
 - [`express`](https://www.npmjs.com/package/express)
-- [`express-pino-logger`](https://www.npmjs.com/package/express-pino-logger)
 - [`swagger-ui-express`](https://www.npmjs.com/package/swagger-ui-express)
 
 As `devDependencies`:
 
 - [`@types/express`](https://www.npmjs.com/package/@types/express)
 - [`@types/cors`](https://www.npmjs.com/package/@types/cors)
-- [`@types/express-pino-logger`](https://www.npmjs.com/package/@types/express-pino-logger)
 - [`@types/swagger-ui-express`](https://www.npmjs.com/package/@types/swagger-ui-express)
 
-#### In case you are using GraphQL
-
-As `dependencies`:
-- [`apollo-server-express`](https://www.npmjs.com/package/apollo-server-express)
-
 ### Fastify case
 
 As `dependencies`:
 
 - [`fastify`](https://www.npmjs.com/package/fastify)
-- [`fastify-cors`](https://www.npmjs.com/package/fastify-cors)
-- [`fastify-swagger`](https://www.npmjs.com/package/fastify-swagger)
+- [`@fastify/swagger`](https://www.npmjs.com/package/@fastify/swagger)
+- [`@fastify/swagger-ui`](https://www.npmjs.com/package/@fastify/swagger-ui)
+- [`@fastify/cors`](https://www.npmjs.com/package/@fastify/cors)
+- [`fastify-type-provider-zod`](https://www.npmjs.com/package/fastify-type-provider-zod)
 
 #### In case you are using GraphQL
 
 As `dependencies`:
-- [`apollo-server-fastify`](https://www.npmjs.com/package/apollo-server-fastify)
-- [`apollo-server-plugin-base`](https://www.npmjs.com/package/apollo-server-plugin-base)
+- [`@as-integrations/fastify`](https://www.npmjs.com/package/@as-integrations/fastify)
 
-Feel free to contribute to this project. Every contribution will be appreciated.
-
-### In case you are using a relational database
-
-As `dependencies`:
-
-- [`sequelize`](https://www.npmjs.com/package/sequelize)
-- [`sequelize-typescript`](https://www.npmjs.com/package/sequelize-typescript)
-- [`sequelize-typescript-migration-lts`](https://www.npmjs.com/package/sequelize-typescript-migration-lts)
 
 #### PostgreSQL case
 
@@ -360,6 +348,8 @@ As `dependencies`:
 
 - [`tedious`](https://www.npmjs.com/package/tedious)
 
+Feel free to contribute to this project. Every contribution will be appreciated.
+
 ## Author
 
 - **Anthony Luzquiños** - _Initial Work_ - _Documentation_ - [AnthonyLzq](https://github.com/AnthonyLzq).

package/bin/index.js

@@ -1,4 +1,8 @@
 #!/usr/bin/env node
+process.on('SIGINT', () => {
+  console.log('\nSimba.js process cancelled\n')
+  process.exit()
+})
 
 const main = require('../lib')