@anthonylzq/simba.js 3.1.0 → 4.2.0

package/README.md

@@ -1,7 +1,9 @@
 # Simba.js
 
 [![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)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
 
 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.
 
@@ -134,9 +136,8 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┗ 📜index.ts
  ┣ 📂network
  ┃ ┣ 📂routes
- ┃ ┃ ┣ 📂schemas
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┣ 📂utils
+ ┃ ┃ ┃ ┗ 📜docs.ts
  ┃ ┃ ┣ 📜home.ts
  ┃ ┃ ┣ 📜index.ts
  ┃ ┃ ┗ 📜user.ts
@@ -144,6 +145,9 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┣ 📜response.ts
  ┃ ┣ 📜routes.ts
  ┃ ┗ 📜server.ts
+ ┣ 📂schemas
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
  ┣ 📂services
  ┃ ┣ 📂utils
  ┃ ┃ ┣ 📂messages
@@ -181,8 +185,6 @@ Regardless of the option chosen, a new folder will be generated with the name of
 📂node_modules
 📂src
  ┣ 📂@types
- ┃ ┣ 📂dto
- ┃ ┃ ┗ 📜user.d.ts
  ┃ ┣ 📂models
  ┃ ┃ ┗ 📜user.d.ts
  ┃ ┗ 📜index.d.ts
@@ -198,9 +200,8 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┗ 📜index.ts
  ┣ 📂network
  ┃ ┣ 📂routes
- ┃ ┃ ┣ 📂schemas
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
+ ┃ ┃ ┣ 📂utils
+ ┃ ┃ ┃ ┗ 📜docs.ts
  ┃ ┃ ┣ 📜docs.ts
  ┃ ┃ ┣ 📜home.ts
  ┃ ┃ ┣ 📜index.ts
@@ -209,6 +210,9 @@ Regardless of the option chosen, a new folder will be generated with the name of
  ┃ ┣ 📜response.ts
  ┃ ┣ 📜routes.ts
  ┃ ┗ 📜server.ts
+ ┣ 📂schemas
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
  ┣ 📂services
  ┃ ┣ 📂utils
  ┃ ┃ ┣ 📂messages
@@ -269,7 +273,7 @@ If you want to check the content of the files, please check the [example](https:
 
 - The provided project structure is inspired in my personal experience as [`Node.js`](https://nodejs.org/en/) developer and the [`Nest`](https://nestjs.com/) framework. It follows a layered architecture:
 
-  1. Presentation layer (network layer): it is represented by the network folder, which contains the routes and the necessary schemas for each route.
+  1. Presentation layer (network layer): it is represented by the network and schemas folders, which contains the routes and the schemas necessary for each route.
   2. Business layer (services layer): it is represented by the services folder, which contains all the code related to the business logic of your application.
   3. Persistance layer (database layer): it is represented by the database folder, which contains the database connection, models and queries (that will be used by the services). Multiple database connection are possible and should be implemented here.
 
@@ -282,7 +286,14 @@ If you want to check the content of the files, please check the [example](https:
 
 ## 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). 
+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 4.x.x
+
+In this major version I would be focusing on adding new possible configurations according to the road map. The major changes of this version will be described here:
+
+- Replaced [`joi`](https://www.npmjs.com/package/joi) in favor of [`ajv`](https://www.npmjs.com/package/ajv) + [`@sinclair/typebox`](https://www.npmjs.com/package/@sinclair/typebox) in the Express case. [Why did I do this?](https://simbajs.notion.site/TypeBox-support-for-Express-f4e3cf8dd06f4c7ba4d8e4051a52688c)
+- Using more descriptive nouns, now every database object is represented with a DBO at the end, like: _UserDBO_. Also the objects that are sent and received will have a DTO at the end, like: _UserDTO_.
 
 ## <a name="notes"></a>Notes
 
@@ -312,6 +323,8 @@ Here is the list of the packages that are being installed, as `devDependencies`:
 
 As `dependencies`:
 
+- [`@sinclair/typebox`](https://www.npmjs.com/package/@sinclair/typebox)
+- [`ajv`](https://www.npmjs.com/package/ajv)
 - [`http-errors`](https://www.npmjs.com/package/http-errors)
 - [`mongoose`](https://mongoosejs.com/)
 
@@ -320,13 +333,14 @@ As `dependencies`:
 As `devDependencies`:
 
 - [`@types/express`](https://www.npmjs.com/package/@types/express)
+- [`@types/cors`](https://www.npmjs.com/package/@types/cors)
 - [`@types/morgan`](https://www.npmjs.com/package/@types/morgan)
 - [`@types/swagger-ui-express`](https://www.npmjs.com/package/@types/swagger-ui-express)
 
 As `dependencies`:
 
-- [`express`](https://expressjs.com/)
-- [`joi`](https://joi.dev/api/?v=17.4.2)
+- [`cors`](https://www.npmjs.com/package/cors)
+- [`express`](https://www.npmjs.com/package/express)
 - [`morgan`](https://www.npmjs.com/package/morgan)
 - [`swagger-ui-express`](https://www.npmjs.com/package/swagger-ui-express)
 
@@ -334,8 +348,8 @@ As `dependencies`:
 
 As `dependencies`:
 
-- [`@sinclair/typebox`](https://www.npmjs.com/package/@sinclair/typebox)
 - [`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)
 
 Feel free to contribute to this project. Every contribution will be appreciated.

package/lib/index.js

@@ -287,8 +287,6 @@ const main = async () => {
     else config.mainFile = argv.mainFile
   }
 
-  console.log(config)
-
   await installation(config)
 }