Create a new template MikroOrm #149

tamzidkarim commented 2 years ago

Content (작업 내용) 📝

🎉 New Template: MikroORM Added MikroORM as a new ORM option which has great support for MongoDB. I used typegoose as my base template as it had a similar sort of setup needed for this template. Inside of database folder, you will find one config file for MikroORM and I have used the index file for exporting all the modules. Inside App.ts, MikroORM has been initialized. It is important that we call the connectToDatabase method after initializing all the middleware. I have used DI containers to work with the ORM throughout the apps, also while testing. You can find about the DI pattern in one of their examples that I have attached below under design links.

Screenshot for work content (작업 내용 스크린샷) 📸

Links (링크) 🔗

Issue Links (이슈 링크) https://github.com/ljlm0402/typescript-express-starter/issues/149
API Links (API 스팩 문서) https://github.com/mikro-orm/mikro-orm
Development Links (개발 문서) https://github.com/tamzidkarim/typescript-express-starter
Document Links (기획 문서) https://mikro-orm.io/docs/installation
Design Links (디자인 문서) https://github.com/mikro-orm/express-ts-example-app

Etc (기타 사항) 🔖

There are a bunch of dependencies that cause issues.
"ts-jest": "^27.0.7", "jest": "^27.0.6", "@types/jest": "^26.0.24" They are not compatiable with each other, so during npm installation you will encounter an error.

I have fixed them. Currently used, "@types/jest": "27.4.x", "jest": "27.4.x", "ts-jest": "^27.1.4". According to Jest official website, they suggest to use to similar @types version as jest itself. https://jestjs.io/docs/getting-started#using-typescript-via-ts-jest

Also I have removed, "@types/dotenv": "^8.2.0", "@types/helmet": "^4.0.0", "@types/winston": "^2.4.4", as types are now shipped with the package itself.

Check List (체크 사항) ✅

[x] Issue (이슈)
[x] Tests (테스트)
[x] Ready to be merged (병합 준비 완료)
[x] Added myself to contributors table (기여자 추가)

ljlm0402 commented 2 years ago

@tamzidkarim

I sincerely thank you for a very nice contribution.

I confirmed the code, so I have a few parts I want to fix, will I leave Review? Or would you like to fix it after PR? Everything is perfect for your contribution to your contribution.

ljlm0402 commented 2 years ago

@tamzidkarim

There is an additional questions.

As a result of writing to other matters, the Jest related module and the deleted @Types module are the tasks that the module should be modified to all templates?

tamzidkarim commented 2 years ago

If it's something that needs to be fixed from my side then sure please leave a review I will change and push the update.

tamzidkarim commented 2 years ago

@tamzidkarim

There is an additional questions.

As a result of writing to other matters, the Jest related module and the deleted @Types module are the tasks that the module should be modified to all templates?

Well, I suppose it should be modified to all templates. But for now I have only made these changes with the new template. So please check from your side and if you find the same issues that I mentioned then all the templates should be changed.

tamzidkarim commented 2 years ago

@ljlm0402 hey in the readme it still says MikroORM(Develop). You might want to change that.

ljlm0402 commented 2 years ago

@tamzidkarim

The code is under review. After the review is complete, we plan to fix it along with the package version update.

tamzidkarim commented 2 years ago

Ok cool.

ljlm0402 / typescript-express-starter