Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New ✨ : Express MongoDB TypeScript template (opinionated) #41

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

IAmRiteshKoushik
Copy link

Description

This PR introduces a TypeScript template for using Express with MongoDB (through Mongoose as ODM). It takes an opinionated approach towards folder structure and code organization.

Resolves the template part of #6

Tagging Maintainers

@Ashrockzzz2003 @Abhinav-ark

Copy link
Member

@Ashrockzzz2003 Ashrockzzz2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution @IAmRiteshKoushik. Please look into the suggestions.

  • Add an example to .env.example or atleast to the README about the format.
  • To integrate this command with quick_start_express CLI tool, you must add it to bin/configs.js.

templates/express_mongo_ts/src/configs/index.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/src/models/user.model.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/src/routes/index.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/src/types/index.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/src/types/user.type.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/src/configs/server.config.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/src/server.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/src/server.ts Outdated Show resolved Hide resolved
templates/express_mongo_ts/yarn.lock Outdated Show resolved Hide resolved
@Ashrockzzz2003 Ashrockzzz2003 added the feature Planned feature of software. label Nov 17, 2024
@Ashrockzzz2003 Ashrockzzz2003 linked an issue Nov 17, 2024 that may be closed by this pull request
5 tasks
@IAmRiteshKoushik
Copy link
Author

IAmRiteshKoushik commented Nov 17, 2024

Thanks for the contribution @IAmRiteshKoushik. Please look into the suggestions.

* [X]  Add an example to `.env.example` or atleast to the `README` about the format.

* [X]  To integrate this command with `quick_start_express` CLI tool, you must add it to `bin/configs.js`.

All aforementioned changes have been made in the latest commits. @Ashrockzzz2003

Copy link
Member

@Ashrockzzz2003 Ashrockzzz2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant by camelCase to rename variables, attribute names in the files and not file name! Sorry if you understood it the other way! Can you revert back file names. Initial version was better! Sorry again!

And did you test if the template being created actually works? When I tried it did not : (

@Abhinav-ark
Copy link
Member

I meant by camelCase to rename variables, attribute names in the files and not file name! Sorry if you understood it the other way! Can you revert back file names. Initial version was better! Sorry again!

And did you test if the template being created actually works? When I tried it did not : (

Types and interface names are conventionally written in PascalCase, so let them alone be in PascalCase. Other variables which are instances can be in camelCase. What do you say @Ashrockzzz2003 ?

@Ashrockzzz2003
Copy link
Member

I meant by camelCase to rename variables, attribute names in the files and not file name! Sorry if you understood it the other way! Can you revert back file names. Initial version was better! Sorry again!
And did you test if the template being created actually works? When I tried it did not : (

Types and interface names are conventionally written in PascalCase, so let them alone be in PascalCase. Other variables which are instances can be in camelCase. What do you say @Ashrockzzz2003 ?

yep. perfect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Planned feature of software.
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Add Template flag and "express and mongoDB" template
3 participants