@anthonylzq/simba.js 6.1.0 → 6.2.0

package/README.md

@@ -3,6 +3,7 @@
   <a href="https://simbajs.notion.site/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df"><img src="https://i.ibb.co/QFX0WnH/simba-pink.png" alt="Simba.js"></a>
 </h1>
 
+
 [![NPM version](https://img.shields.io/npm/v/@anthonylzq/simba.js.svg?style=flat)](https://www.npmjs.com/package/@anthonylzq/simba.js)
 [![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)
@@ -129,318 +130,20 @@ 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 didn't you use [`TypeGraphQL`](https://typegraphql.com/)?
+#### 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
 
-Regardless of the option chosen, a new folder will be generated with the name of the project, it will contain the following structure, depending if you have chosen Express or Fastify:
-
-### Express case
-
-```
-📂.github
-┣ 📂workflows
-┃ ┣ 📜test.yml
-📂node_modules
-📂src
-┣ 📂@types
-┃ ┣ 📂custom
-┃ ┃ ┣ 📜request.d.ts
-┃ ┃ ┗ 📜response.d.ts
-┃ ┣ 📂models
-┃ ┃ ┗ 📜user.d.ts
-┃ ┗ 📜index.d.ts
-┣ 📂database
-┃ ┣ 📂mongo
-┃ ┃ ┣ 📂models
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📂queries
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📜connection.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┗ 📜index.ts
-┣ 📂network
-┃ ┣ 📂routes
-┃ ┃ ┣ 📂utils
-┃ ┃ ┃ ┗ 📜index.ts
-┃ ┃ ┣ 📜home.ts
-┃ ┃ ┣ 📜index.ts
-┃ ┃ ┗ 📜user.ts
-┃ ┣ 📜index.ts
-┃ ┣ 📜response.ts
-┃ ┣ 📜routes.ts
-┃ ┗ 📜server.ts
-┣ 📂schemas
-┃ ┣ 📜index.ts
-┃ ┗ 📜user.ts
-┣ 📂services
-┃ ┣ 📂utils
-┃ ┃ ┣ 📂messages
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┣ 📜index.ts
-┃ ┗ 📜user.ts
-┣ 📂utils
-┃ ┣ 📜docs.json
-┃ ┗ 📜index.ts
-┣ 📜index.ts
-📂test
-┣ 📜index.test.ts
-┣ 📜jestGlobalSetup.ts
-┗ 📜setEnvVars.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜index.http
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜index.http
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
-
-### Express-GraphQL case
+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.
 
-```
-📂.github
-┣ 📂workflows
-┃ ┣ 📜test.yml
-📂node_modules
-📂src
-┣ 📂@types
-┃ ┣ 📂custom
-┃ ┃ ┣ 📜request.d.ts
-┃ ┃ ┗ 📜response.d.ts
-┃ ┣ 📂graphQL
-┃ ┃ ┗ 📜context.d.ts
-┃ ┣ 📂models
-┃ ┃ ┗ 📜user.d.ts
-┃ ┗ 📜index.d.ts
-┣ 📂database
-┃ ┣ 📂mongo
-┃ ┃ ┣ 📂models
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📂queries
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📜connection.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┗ 📜index.ts
-┣ 📂graphQL
-┃ ┣ 📂models
-┃ ┃ ┣ 📂User
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┣ 📜mutations.ts
-┃ ┃ ┃ ┣ 📜mutationsResolver.ts
-┃ ┃ ┃ ┣ 📜queries.ts
-┃ ┃ ┃ ┣ 📜queriesResolver.ts
-┃ ┃ ┃ ┣ 📜schemas.ts
-┃ ┃ ┃ ┗ 📜typeDefs.ts
-┃ ┃ ┣ 📂utils
-┃ ┃ ┃ ┣ 📂messages
-┃ ┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┃ ┗ 📜index.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┗ 📜index.ts
-┣ 📂network
-┃ ┣ 📂routes
-┃ ┃ ┣ 📂utils
-┃ ┃ ┃ ┗ 📜index.ts
-┃ ┃ ┣ 📜home.ts
-┃ ┃ ┣ 📜index.ts
-┃ ┣ 📜index.ts
-┃ ┣ 📜response.ts
-┃ ┣ 📜routes.ts
-┃ ┗ 📜server.ts
-┣ 📂schemas
-┃ ┣ 📜index.ts
-┃ ┗ 📜user.ts
-┣ 📂utils
-┃ ┣ 📜docs.json
-┃ ┗ 📜index.ts
-┣ 📜index.ts
-📂test
-┣ 📜index.test.ts
-┣ 📜jestGlobalSetup.ts
-┗ 📜setEnvVars.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
+Also, if you are interested in the folder structure of each case, please take a look at:
 
-### Fastify case
-
-```
-📂node_modules
-📂src
-┣ 📂@types
-┃ ┣ 📂models
-┃ ┃ ┗ 📜user.d.ts
-┃ ┗ 📜index.d.ts
-┣ 📂database
-┃ ┣ 📂mongo
-┃ ┃ ┣ 📂models
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📂queries
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📜connection.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┗ 📜index.ts
-┣ 📂network
-┃ ┣ 📂routes
-┃ ┃ ┣ 📂utils
-┃ ┃ ┃ ┗ 📜docs.ts
-┃ ┃ ┣ 📜docs.ts
-┃ ┃ ┣ 📜home.ts
-┃ ┃ ┣ 📜index.ts
-┃ ┃ ┗ 📜user.ts
-┃ ┣ 📜index.ts
-┃ ┣ 📜response.ts
-┃ ┣ 📜routes.ts
-┃ ┗ 📜server.ts
-┣ 📂schemas
-┃ ┣ 📜index.ts
-┃ ┗ 📜user.ts
-┣ 📂services
-┃ ┣ 📂utils
-┃ ┃ ┣ 📂messages
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┣ 📜index.ts
-┃ ┗ 📜user.ts
-┣ 📜index.ts
-📂test
-┣ 📜index.test.ts
-┣ 📜jestGlobalSetup.ts
-┗ 📜setEnvVars.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜index.http
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜index.http
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
-
-### Fastify-GraphQL case
-
-```
-📂.github
-┣ 📂workflows
-┃ ┣ 📜test.yml
-📂node_modules
-📂src
-┣ 📂@types
-┃ ┣ 📂graphQL
-┃ ┃ ┗ 📜context.d.ts
-┃ ┣ 📂dto
-┃ ┃ ┗ 📜user.d.ts
-┃ ┣ 📂models
-┃ ┃ ┗ 📜user.d.ts
-┃ ┗ 📜index.d.ts
-┣ 📂database
-┃ ┣ 📂mongo
-┃ ┃ ┣ 📂models
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📂queries
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┣ 📜connection.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┗ 📜index.ts
-┣ 📂graphQL
-┃ ┣ 📂models
-┃ ┃ ┣ 📂User
-┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┣ 📜mutations.ts
-┃ ┃ ┃ ┣ 📜mutationsResolver.ts
-┃ ┃ ┃ ┣ 📜queries.ts
-┃ ┃ ┃ ┣ 📜queriesResolver.ts
-┃ ┃ ┃ ┣ 📜schemas.ts
-┃ ┃ ┃ ┗ 📜typeDefs.ts
-┃ ┃ ┣ 📂utils
-┃ ┃ ┃ ┣ 📂messages
-┃ ┃ ┃ ┃ ┣ 📜index.ts
-┃ ┃ ┃ ┃ ┗ 📜user.ts
-┃ ┃ ┃ ┗ 📜index.ts
-┃ ┃ ┗ 📜index.ts
-┃ ┗ 📜index.ts
-┣ 📂network
-┃ ┣ 📂routes
-┃ ┃ ┣ 📜docs.ts
-┃ ┃ ┣ 📜home.ts
-┃ ┃ ┣ 📜index.ts
-┃ ┣ 📜index.ts
-┃ ┣ 📜response.ts
-┃ ┣ 📜routes.ts
-┃ ┗ 📜server.ts
-┣ 📂schemas
-┃ ┣ 📜index.ts
-┃ ┗ 📜user.ts
-┣ 📜index.ts
-📂test
-┣ 📜index.test.ts
-┣ 📜jestGlobalSetup.ts
-┗ 📜setEnvVars.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
-
-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.
+- [Express case](./projectStructureExamples/express.txt)
+- [Express-GraphQL case](./projectStructureExamples/express-graphql.txt)
+- [Fastify case](./projectStructureExamples/fastify.txt)
+- [Fastify-GraphQL case](./../projectStructureExamples/fastify-graphql.txt)
 
 ### Some considerations
 
@@ -484,6 +187,25 @@ If you want to check the content of the files, please check the [example](https:
 - 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.
 
+## 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>
+
 ## 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).

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@anthonylzq/simba.js",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "scripts": {
     "service": "node ./bin",
     "help": "node ./bin --help",
     "release": "standard-version",
-    "test": "npm run build && npm run test:express:local && npm run test:fastify:local && npm run test:express:graphql:local && npm run test:fastify:graphql:local",
+    "test": "npm run build && npm run test:express:local && npm run test:fastify:local && npm run test:express:graphql:local && npm run test:fastify:graphql:local && git restore .",
     "test:ci": "npm run build && npm run test:express:ci && npm run test:fastify:ci && npm run test:express:graphql:ci && npm run test:fastify:graphql:ci",
     "test:only": "npm run test:express:local && npm run test:fastify:local && npm run test:express:graphql:local && npm run test:fastify:graphql:local",
     "build": "npm run rm && npm run build:express && npm run build:fastify && npm run build:express:graphql && npm run build:fastify:graphql",
@@ -34,7 +34,13 @@
     "test:express:graphql:ci": "if [ -d \"example/express-graphql/node_modules\" ]; then npm run test:ci --prefix example/express-graphql; else echo 'Can not run the test for express api because the dependencies are not installed'; fi",
     "test:fastify:graphql:ci": "if [ -d \"example/fastify-graphql/node_modules\" ]; then npm run test:ci --prefix example/fastify-graphql; else echo 'Can not run the test for fastify api because the dependencies are not installed'; fi",
     "cd:mv:example": "if [ ! -d \"example\" ]; then mkdir example && cd example; fi",
-    "version": "npm run release && git add CHANGELOG.md"
+    "version": "npm run release && npm run list:directory:tree:examples && git add .",
+    "remove:node_modules": "if [ -f \"example/express/node_modules\" ]; then rm -rf example/express/node_modules; fi && if [ -d \"example/express-graphql/node_modules\" ]; then rm -rf example/express-graphql/node_modules; fi && if [ -d \"example/fastify/node_modules\" ]; then rm -rf example/fastify/node_modules; fi && if [ -d \"example/fastify-graphql/node_modules\" ]; then rm -rf example/fastify-graphql/node_modules; fi",
+    "list:directory:tree:express": "npm run remove:node_modules && if [ -f \"projectStructureExamples/express.txt\" ]; then rm projectStructureExamples/express.txt; fi && tree example/express -a --dirsfirst --sort name | cut -d'/' -f 2 | head -n -2 >> projectStructureExamples/express.txt",
+    "list:directory:tree:express-graphql": "npm run remove:node_modules && if [ -f \"projectStructureExamples/express-graphql.txt\" ]; then rm projectStructureExamples/express-graphql.txt; fi && tree example/express -a --dirsfirst --sort name | cut -d'/' -f 2 | head -n -2 >> projectStructureExamples/express-graphql.txt",
+    "list:directory:tree:fastify": "npm run remove:node_modules && if [ -f \"projectStructureExamples/fastify.txt\" ]; then rm projectStructureExamples/fastify.txt; fi && tree example/express -a --dirsfirst --sort name | cut -d'/' -f 2 | head -n -2 >> projectStructureExamples/fastify.txt",
+    "list:directory:tree:fastify-graphql": "npm run remove:node_modules && if [ -f \"projectStructureExamples/fastify-graphql.txt\" ]; then rm projectStructureExamples/fastify-graphql.txt; fi && tree example/express -a --dirsfirst --sort name | cut -d'/' -f 2 | head -n -2 >> projectStructureExamples/fastify-graphql.txt",
+    "list:directory:tree:examples": "npm run list:directory:tree:express && npm run list:directory:tree:express-graphql && npm run list:directory:tree:fastify && npm run list:directory:tree:fastify-graphql"
   },
   "bin": {
     "simba": "./bin/index.js"