Skip to content

Commit 3ec9894

Browse files
authored
Merge pull request #215 from code-collabo/clean-up
Add API boilerplate templates v1.0.0 (and other clean ups in prep for CLI v2.0.0)
2 parents 5eb73fb + d98241a commit 3ec9894

75 files changed

Lines changed: 29646 additions & 4720 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.eslintrc.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
},
1313
"env": {
1414
"browser": true,
15-
"node": true
15+
"node": true,
16+
"es6": true
1617
},
1718
"rules": {
1819
"no-console": 1

.github/workflows/node.js.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ jobs:
1616

1717
strategy:
1818
matrix:
19-
node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
19+
node-version: [16.x, 17.x, 18.x, 19.x, 20.x]
20+
# node version 12, 13, 14 says cannot find arg of undefined, 15 says bad engine for most upgraded packages in the cli so they have been removed from our node versions
2021
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
2122

2223
steps:

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99

1010
#
1111

12-
> **Note**
13-
>
14-
> node-mongo projects require you to have Node.js or Node Version Manager (NVM) installed on your computer
12+
> **Note**
13+
>
14+
> node-mongo projects require you to have Node.js or Node Version Manager (NVM) installed on your computer
1515
1616
#
1717

18-
**Supported Node.js versions:** Node.js v12.x to v18.x
18+
**Supported Node.js versions:** Node.js v16.x to v20.x
1919

2020
#
2121

@@ -26,8 +26,8 @@
2626
**Parent repo:** [code-collabo/node-mongo](https://github.com/code-collabo/node-mongo)
2727

2828
#
29-
> **Note**
30-
>
29+
> **Note**
30+
>
3131
> The latest version of CLI generates API boilerplate templates v1.0.0
3232
3333
#
@@ -49,7 +49,7 @@ The [node-mongo-cli](https://www.npmjs.com/package/@code-collabo/node-mongo-cli)
4949

5050
* API boilerplate templates now use the MVC architecture pattern i.e. separated route, model, controller, and service files.
5151
* Development environment already set up with @babel (for esm template only), eslint, and server watch.
52-
* The default connection setup type is MongoDB Atlas. But you get to choose if you want to use it or switch to the Local mongoDB connection setup type.
52+
* The default connection setup type is MongoDB Atlas. You get to choose if you want to use Atlas or switch to the Local mongoDB connection setup type, and you also get to save your preferred connection setup type for when next you run the automated development server.
5353
* Improved user experience with the newly added walk-through prompts in the terminal: quick to setup, easy to use, with automated and improved user support.
5454

5555
### CLI installation
@@ -64,11 +64,6 @@ After installing globally, use the node-mongo command.
6464
node-mongo
6565
````
6666

67-
### Show CLI help
68-
````
69-
node-mongo --help
70-
````
71-
7267
### CLI usage
7368
````
7469
node-mongo <folder_name> <template>
@@ -82,6 +77,15 @@ Replace \<folder\_name> with your preferred folder name. Replace \<template> wit
8277
node-mongo test-folder ts
8378
```
8479

80+
### API boilerplate template and automated development server
81+
82+
See the [API boilerplate templates documentation](https://code-collabo.gitbook.io/node-mongo-v2.0.0/api-boilerplate-templates) for detailed steps to setup your generated API boilerplate template, run the automated development server, and build your own mongoDB backend application with it.
83+
84+
### Show CLI help
85+
````
86+
node-mongo --help
87+
````
88+
8589
### CLI flags
8690
````
8791
-h, --help Show help
@@ -111,7 +115,7 @@ specified or when folder name already exists.
111115
## Documentation
112116
See the links to the official documentation of the node-mongo project and community building it below:
113117
- [Node Mongo documentation](https://code-collabo.gitbook.io/node-mongo-v2.0.0)
114-
- [Code Collabo documentation](https://code-collabo.gitbook.io/doc/)
118+
- [Code Collabo documentation](https://code-collabo.gitbook.io/community-doc-v1.0.0)
115119

116120
## Appreciation
117121
Appreciation to [@dkundel](https://github.com/dkundel), [@academind](https://github.com/academind), [@CodAffection](https://github.com/CodAffection), [@coryhouse](https://github.com/coryhouse) for the awesome helpful course resources they create, and to [@jiobiagba](https://github.com/jiobiagba) and [@IsraelObiagba](https://github.com/IsraelObiagba) for their occasional but mighty contributions.

0 commit comments

Comments
 (0)