Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
171 commits
Select commit Hold shift + click to select a range
281a864
Update LICENSE
Ifycode Apr 9, 2021
eb3d5f1
Add word Community to org name in license
Ifycode Apr 9, 2021
8966960
Update all docs links
Ifycode Apr 11, 2021
85812f6
Transfer contributors to docs
Ifycode Apr 11, 2021
f55caa1
Update README.md
Ifycode Apr 11, 2021
21ae3ae
Delete CODE_OF_CONDUCT.md
Ifycode Apr 11, 2021
590c9fa
Delete contributor.md
Ifycode Apr 11, 2021
e0da56c
Delete contributing.md
Ifycode Apr 11, 2021
322ad1b
Update links
Ifycode Apr 11, 2021
31d910e
Create task creation template
Ifycode May 9, 2021
393d7da
Merge pull request #67 from code-collabo/2-task-template
Ifycode May 9, 2021
8c8c951
Create bug template
Ifycode May 9, 2021
c685821
Merge pull request #68 from code-collabo/2-bug-template
Ifycode May 9, 2021
a50c523
Update task template assignee & label
Ifycode May 9, 2021
4d17844
Create pull_request_template.md
Ifycode May 9, 2021
dd7969f
Merge pull request #69 from code-collabo/2-pull-request-template
Ifycode May 9, 2021
3152595
Fix folder overwrite when there's no args & separate the prompts
Ifycode May 13, 2021
5b88501
Fix folder overwrite when options.folder arg is present
Ifycode May 13, 2021
02216e8
Fix skip git warning - remove unused/unneeded code
Ifycode May 13, 2021
26b19fe
Add task label, remove assignee
Ifycode May 14, 2021
a16a12e
Add bug label
Ifycode May 14, 2021
17c9e22
Add empty assignee column as before
Ifycode May 14, 2021
090ae3e
Fix folder overwrite not previously existing folder when options.fold…
Ifycode May 14, 2021
bc8259e
Merge pull request #70 from code-collabo/55-content-overwrite
Ifycode May 13, 2021
1977972
Change es6 to esm
Ifycode May 14, 2021
d804222
Clean up comments & unneeded console.logs
Ifycode May 14, 2021
8779671
Clean up comments
Ifycode May 15, 2021
57b91d9
Merge branch 'develop' of github.com:code-collabo/node-mongo-cli into…
Ifycode May 15, 2021
e8dba6a
Temporary fix for install bug/issue
Ifycode May 15, 2021
bce2705
Merge pull request #74 from code-collabo/73-fix-install-bug
Ifycode May 15, 2021
addb072
Detect, change & increment defaultFolderName if already in use
Ifycode May 15, 2021
c9d024e
Merge pull request #75 from code-collabo/71-default-folder-name
Ifycode May 15, 2021
bd25cbc
Update .all-contributorsrc
Ifycode May 16, 2021
b625d89
Update .all-contributorsrc
Ifycode May 16, 2021
0f7a916
Remove bug
Ifycode May 16, 2021
e583c36
Remove Obiagba Mary
Ifycode May 16, 2021
a65d107
Remove Obiagba Mary
Ifycode May 16, 2021
5dd6ac1
docs: update contributor.md [skip ci]
allcontributors[bot] May 16, 2021
3246fdf
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] May 16, 2021
3962893
Add and set contributorsSortAlphabetically to true
Ifycode May 16, 2021
be73727
Set contributors per line to 4 for now
Ifycode May 16, 2021
a0fda7b
Merge pull request #80 from code-collabo/all-contributors/add-Ifycode
Ifycode May 16, 2021
ee90cb8
docs: update contributor.md [skip ci]
allcontributors[bot] May 16, 2021
fbd8cfb
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] May 16, 2021
1b03bf7
Update number of contributors
Ifycode May 16, 2021
7746caf
Merge pull request #81 from code-collabo/all-contributors/add-chuddyj…
Ifycode May 16, 2021
fb96bee
Link to cli contributors - develop branch
Ifycode May 16, 2021
8285488
Prepare repo for adding node-mongo-cli contributors
Ifycode May 16, 2021
df7fb87
Update .all-contributorsrc
Ifycode May 16, 2021
9ea8d68
Fix wrong prompt when folderName arg is not present
Ifycode May 16, 2021
fe269b1
Merge pull request #82 from code-collabo/76-fix-wrong-prompt
Ifycode May 16, 2021
77015b7
Make comments used as guide more explanatory
Ifycode May 16, 2021
520c803
Fix empty folder prompt bug
Ifycode May 16, 2021
f025050
Merge pull request #84 from code-collabo/77-fix-empty-folder-prompt
Ifycode May 16, 2021
c5607ad
Made 'quote_type' rule applicable to both .js and .ts files
chuddyjoachim May 17, 2021
7d38524
Merge pull request #88 from chuddyjoachim/develop-joachim
Ifycode May 18, 2021
3173c81
npm link (original)
Ifycode Sep 8, 2021
88b2867
Add OS check for templateDirectory's new url
Ifycode Sep 13, 2021
ee5a5ab
Merge pull request #90 from code-collabo/os-check
Ifycode Sep 13, 2021
cd87f88
Separate folder Prompt function and move to another file
Ifycode Sep 13, 2021
e09528f
ran audit fix
chuddyjoachim Sep 13, 2021
7b01276
Prepare options.skipPrompts for template function separation
Ifycode Sep 14, 2021
28549cd
rename name in package.json same as project's name
chuddyjoachim Sep 14, 2021
6c7d2dc
separate skipPrompts from template
Ifycode Sep 14, 2021
d84be60
Remove template prompt and folder prompt when --yes flag is specified
Ifycode Sep 14, 2021
e59fadd
Work in progress
Ifycode Sep 14, 2021
f0512f8
Remove prompt and increment default folder name when --yes flag is sp…
Ifycode Sep 14, 2021
a1cf8cb
Change function names to better represent it's purpose
Ifycode Sep 14, 2021
adaedb4
Move template missing option prompt to it's own file
Ifycode Sep 14, 2021
28f7ba8
Remove unnecessary console logs in preparation for --help flag, and c…
Ifycode Sep 15, 2021
99adf33
Merge pull request #92 from chuddyjoachim/develop-joachim
Ifycode Sep 15, 2021
b492a70
Update LICENSE
Ifycode Sep 17, 2021
f87e6ab
Fix since markup not working
Ifycode Sep 17, 2021
2f067e8
mention project name
Ifycode Sep 17, 2021
424c4f4
Add YouTube resource
Ifycode Sep 17, 2021
535cf3f
Merge pull request #94 from code-collabo/license
Ifycode Sep 17, 2021
7d185b4
Fix folder name increment: Prevent prompt anytime folder name matches…
Ifycode Sep 18, 2021
5f1de5a
Execfile work in progress: Make npm install more interactive
Ifycode Sep 18, 2021
19cb31d
Merge pull request #91 from code-collabo/separate-func
Ifycode Sep 19, 2021
6f4f449
Merge pull request #95 from code-collabo/fix-increment
Ifycode Sep 19, 2021
2aca6ba
Add npm install progress in terminal using spawn child process
Ifycode Sep 19, 2021
10a0aef
Remove on listeners to fix null error for spawn's usage and add to li…
Ifycode Sep 19, 2021
460dc2a
Merge branch 'develop' into fix-install
Ifycode Sep 19, 2021
6914a5e
Remove pkg-install
Ifycode Sep 19, 2021
2197525
Merge pull request #97 from code-collabo/fix-install
Ifycode Sep 19, 2021
7b8fb9c
Change function names and to arrow function if needed
Ifycode Sep 20, 2021
59e603c
Change cliOptions to options in npmInstall function
Ifycode Sep 20, 2021
b72b981
Change folder.js to foldername.js
Ifycode Sep 20, 2021
75dc748
Fix async omission error
Ifycode Sep 20, 2021
9a0835f
Improve console and error msgs in main.js
Ifycode Sep 20, 2021
7d40e91
Improve console msgs for template & folder name. Fix other minor issues
Ifycode Sep 20, 2021
b044930
Merge pull request #99 from code-collabo/consistency
Ifycode Sep 20, 2021
4716ead
Configure help flag to work
Ifycode Sep 21, 2021
7459cc7
Forgot to make --help boolean
Ifycode Sep 21, 2021
d1b0882
Merge pull request #100 from code-collabo/help-flag
Ifycode Sep 22, 2021
b1cc224
Fix error when wrong flags are used, also fix console msg for skipPrompt
Ifycode Sep 22, 2021
184d468
Update notes in help command info
Ifycode Sep 22, 2021
e5f17c8
Merge pull request #102 from code-collabo/fix-error
Ifycode Sep 22, 2021
050703d
Test workflow for node v16
Ifycode Sep 27, 2021
a115b50
Fix readme and make it easily understandable
Ifycode Sep 27, 2021
d6d2346
Add documentation, appreciation and contributors sections
Ifycode Sep 27, 2021
07810b2
Preparing to add mentors and contributors
Ifycode Sep 27, 2021
0119cad
Delete .all-contributorsrc
Ifycode Sep 27, 2021
3e24d20
Delete contributor.md
Ifycode Sep 27, 2021
2d641da
Remove all contributors badge
Ifycode Sep 27, 2021
5a5966f
docs: update README.md [skip ci]
allcontributors[bot] Sep 27, 2021
d4c255e
docs: create .all-contributorsrc [skip ci]
allcontributors[bot] Sep 27, 2021
0b48df7
Merge pull request #105 from code-collabo/all-contributors/add-dkundel
Ifycode Sep 27, 2021
85532b3
docs: update README.md [skip ci]
allcontributors[bot] Sep 27, 2021
e3f60e1
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Sep 27, 2021
1cfb1c1
Merge pull request #106 from code-collabo/all-contributors/add-academind
Ifycode Sep 27, 2021
b78330c
docs: update README.md [skip ci]
allcontributors[bot] Sep 27, 2021
08ac99a
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Sep 27, 2021
03b42d0
Merge pull request #107 from code-collabo/all-contributors/add-CodAff…
Ifycode Sep 27, 2021
b3f51e2
docs: update README.md [skip ci]
allcontributors[bot] Sep 27, 2021
a458be6
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Sep 27, 2021
b08ebd5
Merge pull request #108 from code-collabo/all-contributors/add-coryhouse
Ifycode Sep 27, 2021
e867fe2
docs: update README.md [skip ci]
allcontributors[bot] Sep 27, 2021
c2beabc
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Sep 27, 2021
1fd3f90
Merge pull request #109 from code-collabo/all-contributors/add-Israel…
Ifycode Sep 27, 2021
f824962
docs: update README.md [skip ci]
allcontributors[bot] Sep 27, 2021
48173d9
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Sep 27, 2021
b6c8b49
Merge pull request #110 from code-collabo/all-contributors/add-jiobiagba
Ifycode Sep 27, 2021
9fc1119
Clean up appreciation section and remove badge
Ifycode Sep 28, 2021
f7bf86b
Delete .all-contributorsrc
Ifycode Sep 28, 2021
c0dbcb8
docs: update README.md [skip ci]
allcontributors[bot] Sep 28, 2021
0788078
docs: create .all-contributorsrc [skip ci]
allcontributors[bot] Sep 28, 2021
edb3f71
Merge pull request #111 from code-collabo/all-contributors/add-Ifycode
Ifycode Sep 28, 2021
be5679b
docs: update README.md [skip ci]
allcontributors[bot] Sep 28, 2021
de14fdd
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Sep 28, 2021
729775b
Merge pull request #112 from code-collabo/all-contributors/add-chuddy…
Ifycode Sep 28, 2021
4a5a81d
docs: update README.md [skip ci]
allcontributors[bot] Sep 28, 2021
314fb15
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Sep 28, 2021
7a0b183
Add all-contributors bot and clean up project
Ifycode Sep 28, 2021
fcadd4f
Merge pull request #113 from code-collabo/all-contributors/add-all-co…
Ifycode Sep 28, 2021
976aa6a
Update README.md
Ifycode Sep 28, 2021
a2a7518
Create README.md
Ifycode Sep 28, 2021
ec8491c
Create .gitbook.yaml
Ifycode Sep 28, 2021
d057d1a
Initial node-mongo content to be adjusted
Ifycode Sep 28, 2021
a247f6f
GitBook: [develop] 6 pages modified
Ifycode Sep 28, 2021
267953f
GitBook: [develop] 5 pages modified
Ifycode Sep 28, 2021
f6a3644
GitBook: [develop] one page modified
Ifycode Sep 28, 2021
828a4a9
GitBook: [develop] 5 pages modified
Ifycode Sep 28, 2021
5666a46
GitBook: [develop] 4 pages modified
Ifycode Sep 28, 2021
3cff7ea
GitBook: [develop] 4 pages modified
Ifycode Sep 28, 2021
07d31a2
GitBook: [develop] 3 pages modified
Ifycode Sep 28, 2021
fd59648
GitBook: [develop] 3 pages modified
Ifycode Sep 28, 2021
61d0b73
GitBook: [develop] one page modified
Ifycode Sep 28, 2021
8150b60
GitBook: [develop] one page modified
Ifycode Sep 28, 2021
6dbcd7e
GitBook: [develop] one page modified
Ifycode Sep 29, 2021
88c43db
GitBook: [develop] one page modified
Ifycode Sep 29, 2021
78a56e9
Delete untitled.md
Ifycode Sep 29, 2021
4db21b2
Delete untitled.md
Ifycode Sep 29, 2021
48c7ca1
Delete doc/user-guide directory
Ifycode Sep 29, 2021
2755a6e
Add want to contribute section, add links and fix header
Ifycode Sep 29, 2021
a5095a9
Merge pull request #114 from code-collabo/readme-fix
Ifycode Sep 29, 2021
b2c94bb
Add project resources from doc
Ifycode Sep 29, 2021
58c95e6
Test node 12 - 16
Ifycode Sep 29, 2021
3714e5f
GitBook: [develop] 5 pages modified
Ifycode Sep 29, 2021
fc62f5b
GitBook: [develop] 4 pages modified
Ifycode Sep 29, 2021
18d0d7c
Merge pull request #104 from code-collabo/ci-v16
Ifycode Sep 29, 2021
07a4e26
Delete project-development.md
Ifycode Sep 29, 2021
29bfdb2
Add real templates
Ifycode Sep 29, 2021
a3183ef
Add supported node versions
Ifycode Sep 29, 2021
37c3d63
Reference @dkundel's create-project licence file
Ifycode Sep 29, 2021
baac556
Update node version in both root and doc
Ifycode Sep 29, 2021
8ac5972
Merge pull request #115 from code-collabo/add-templates
Ifycode Sep 29, 2021
0d0a17b
v1.0.0 release npm publish settings
Ifycode Sep 29, 2021
96f41a6
Add official documentation section and links
Ifycode Sep 29, 2021
32386a8
Merge pull request #116 from code-collabo/publish-settings
Ifycode Sep 29, 2021
d20fb03
Fix documentation section
Ifycode Sep 29, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 11 additions & 16 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,25 @@
"profile": "https://github.com/Ifycode",
"contributions": [
"code",
"doc",
"infra",
"maintenance",
"review",
"projectManagement",
"ideas"
"doc"
]
},
{
"login": "IsraelObiagba",
"name": "Israel Obiagba",
"avatar_url": "https://avatars.githubusercontent.com/u/14045379?v=4",
"profile": "https://github.com/IsraelObiagba",
"login": "chuddyjoachim",
"name": "Chikezie Joachim",
"avatar_url": "https://avatars.githubusercontent.com/u/56943504?v=4",
"profile": "http://chuddyjoachim.com",
"contributions": [
"mentoring"
"code"
]
},
{
"login": "jiobiagba",
"name": "Joseph Obiagba",
"avatar_url": "https://avatars.githubusercontent.com/u/42423547?v=4",
"profile": "https://github.com/jiobiagba",
"login": "all-contributors",
"name": "All Contributors",
"avatar_url": "https://avatars.githubusercontent.com/u/46410174?v=4",
"profile": "https://allcontributors.org",
"contributions": [
"mentoring"
"infra"
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.ts]
[.{js,ts}]
quote_type = single

[*.md]
Expand Down
1 change: 1 addition & 0 deletions .gitbook/.gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
root: ./doc
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/create-a-task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Create a task
about: Pattern to follow while creating a task to be solved
title: ''
labels: task
assignees: ''

---

Pattern to follow when creating a new task. Note: This is not for bug report. A separate template exists for reporting bugs.

#### Task description
Give brief intro and describe what the task entails.

#### Test cases and expected output
Include test cases e.g. commands to run and expected output. Add screenshots if/where possible.

#### Examples
You can include examples of files, repos, issues or pull requests where something similar to the task you're describing has been done, if any.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/report-a-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Report a bug
about: Found a bug? Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Run this command '....'
3. See error etc.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**This pull request makes the following changes:**
* Fixes issue code-collabo/node-mongo-cli#issueNumberHere

**Details:**
* Setup for '...'
* Adds '...' etc.

**Testing checklist:**
- [ ] Run '...'
- [ ] Check that '...'
- [ ] Check that '...' etc.
- [ ] I certify that I ran my checklist.

Ping @code-collabo/node-mongo-cli
2 changes: 1 addition & 1 deletion .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:

strategy:
matrix:
node-version: [10.x, 12.x, 14.x]
node-version: [12.x, 13.x, 14.x, 15.x, 16.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# See http://help.github.com/ignore-files/ for more about ignoring files.

# testing and rough work
test.js

# dependencies
/node_modules

Expand Down
1 change: 0 additions & 1 deletion CODE_OF_CONDUCT.md

This file was deleted.

8 changes: 7 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ISC License (ISC)
Copyright 2021 Code Collabo
Copyright 2021 Obiagba Mary | Code Collabo Community

Permission to use, copy, modify, and/or
distribute this software for any purpose
Expand All @@ -18,3 +18,9 @@ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
THE USE OR PERFORMANCE OF THIS SOFTWARE.

@dkundel's create-project LICENCE file:
https://github.com/dkundel/create-project/blob/master/LICENSE

List of project resources:
https://code-collabo.gitbook.io/node-mongo/contribution-guide/development-mode#project-resources
112 changes: 91 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,45 +5,115 @@

![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat) ![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg) ![GitHub issues](https://img.shields.io/github/issues/code-collabo/node-mongo-cli?color=red) ![GitHub pull requests](https://img.shields.io/github/issues-pr/code-collabo/node-mongo-cli?color=goldenrod)

`node-mongo-cli` is a command-line interface tool useful to initialize, scaffold and make mongoDB development easier in nodejs environment. With the CLI, you can install any of the starter kit templates - [es6](https://github.com/code-collabo/node-mongo-starter-kit) and [cjs](https://github.com/code-collabo/node-mongo-starter-cjs). It not only helps install the starter-kit, but also allows you to add new model and controller files with content using simple commands.
**Supported node versions:** node v12.x to v16.x

The [cli](https://github.com/code-collabo/node-mongo-cli) is built to help provide better experience when using the starter-kit in MongoDB, MERN or MEAN projects.
The **node-mongo-cli** is a command-line interface made with nodejs. It bootstraps any of these 3 boilerplate templates for your nodejs and/or mongoDB development:
- [ES module template](https://github.com/code-collabo/node-mongo-esm-kit)
- [Commonjs template](https://github.com/code-collabo/node-mongo-cjs-kit)
- Typescript (coming soon)

## Features
### CLI
- CLI bootstraps the esm, cjs or ts templates for nodejs and/or mongoDB development.
- Install dependencies and intialize git for the template bootstrapped or choose to skip them.
- Folders are automatically created based on user entry in prompt or command-line.
- Default folder name is provided and incremented if name already exists.
### Templates
- [Two mongoDB connection options](https://code-collabo.gitbook.io/node-mongo/boilerplate-templates#mongodb-connection-options) to pick from in the templates: your installed mongoDB and mongoDBatlas.
- [Demo CRUD app](https://github.com/code-collabo/node-mongo-demo-app) you can go and download to test that your connection is setup and show example usage of the templates.

## Installation
Install CLI globally with this command:
````
npm install -g @code-collabo/node-mongo-cli
````

## Command
After installing globally, use the node-mongo command.
````
node-mongo
````

### Usage
````
node-mongo <folder_name> <template>
````

### Usage example
The example below will bootstrap the cjs template i.e. the common js template into a folder named test-folder.
````
node-mongo test-folder cjs
````

### Flags
````
-h, --help Show help
-i, --install Install dependencies
-g, --git Initialize git repo
-s, --skip-install Skip installing dependencies
-x, --skip-git Skip initializing git
-y, --yes See note on --yes flag below
````

### Prompts
If you do not specify one or both arguments above,
you will be prompted to add your folder name and/or
choose template option from list. For foldername, you
can choose to use the default foldername provided in
the prompt or type in your preferred folder name.

### Skip prompts
No prompt when --yes flag is used. It skips both
install and git init, and uses esm template as default
if no template is specified or if template entered is
not in the template collection. In the case of folder
name, default foldername is used if no folder name is
specified or when folder name already exists.

## Documentation
For easy maintenance (due to modifications to be made and addition of more features) and also to provide you better support, sections previously included in the readme have been [moved to our docs](https://github.com/code-collabo/docs). Simply click on any of the links to learn to install, use and contribute to the node-mongo project.
#### Using node-mongo
No user guide yet, work is still in progress.
See the links for the official [node-mongo documentation](https://code-collabo.gitbook.io/node-mongo/) and [Code Collabo documentation](https://code-collabo.gitbook.io/doc/).

## Want to contribute?
Love the project and wish to contribute? See contribution guide in the [node-mongo gitbook documentation](https://code-collabo.gitbook.io/node-mongo/) for how to start contributing. You can also reach out to [@Ifycode](https://github.com/Ifycode) in case you need any assistance.

## Appreciation
Appreciation goes to [@dkundel](https://github.com/dkundel), [@academind](https://github.com/academind), [@CodAffection](https://github.com/CodAffection), [@coryhouse](https://github.com/coryhouse) whose awesome youTube videos, articles and/or courses helped a lot while building the node-mongo project - cli, templates and/or demo app. Also to [@IsraelObiagba](https://github.com/IsraelObiagba) and [@jiobiagba](https://github.com/jiobiagba) for their help.

<table>
<tr>
<td align="center"><a href="https://dkundel.com"><img src="https://avatars.githubusercontent.com/u/1505101?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dominik Kundel</b></sub></a><br /><a href="#mentoring-dkundel" title="Mentoring">🧑‍🏫</a></td>
<td align="center"><a href="https://academind.com"><img src="https://avatars.githubusercontent.com/u/28806202?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Academind</b></sub></a><br /><a href="#mentoring-academind" title="Mentoring">🧑‍🏫</a></td>
<td align="center"><a href="http://codaffection.com/"><img src="https://avatars.githubusercontent.com/u/32505654?v=4?s=100" width="100px;" alt=""/><br /><sub><b>CodAffection</b></sub></a><br /><a href="#mentoring-CodAffection" title="Mentoring">🧑‍🏫</a></td>
<td align="center"><a href="http://www.bitnative.com"><img src="https://avatars.githubusercontent.com/u/1688997?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cory House</b></sub></a><br /><a href="#mentoring-coryhouse" title="Mentoring">🧑‍🏫</a></td>
<td align="center"><a href="https://github.com/IsraelObiagba"><img src="https://avatars.githubusercontent.com/u/14045379?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Israel Obiagba</b></sub></a><br /><a href="#mentoring-IsraelObiagba" title="Mentoring">🧑‍🏫</a></td>
<td align="center"><a href="https://github.com/jiobiagba"><img src="https://avatars.githubusercontent.com/u/42423547?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joseph Obiagba</b></sub></a><br /><a href="#mentoring-jiobiagba" title="Mentoring">🧑‍🏫</a></td>
</tr>
</table>

#### Contributing to node-mongo
* See [docs: contributor guide](https://github.com/code-collabo/docs/tree/main/contributor-guide) which contains ***contributing.md***, ***CODE_OF_CONDUCT***, ***git workflow*** and ***project development setup*** to help you get started.
<!--
## Technologies

## Resources
You can [use these resources](https://github.com/code-collabo/docs/blob/main/contributor-guide/node-mongo-project/resources.md) as guide while contributing to the project. Appreciation goes to authors [@dkundel](https://github.com/dkundel), [@academind](https://github.com/academind), [@CodAffection](https://github.com/CodAffection), whose awesome youTube videos and/or articles make up this list of resources, and which have been useful to building the node-mongo project so far. Also to [@coryhouse](https://github.com/coryhouse), author of building a javascript development environment course.
[<img alt="javascript" height="25px" src="https://www.freepnglogos.com/uploads/javascript/javascript-online-logo-for-website-0.png" />](https://github.com/code-collabo/node-mongo-cli)
[<img alt="node js" height="25px" src="https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg" />](https://github.com/code-collabo/node-mongo-cli)
[<img alt="mongoDB" height="25px" src="https://webassets.mongodb.com/_com_assets/cms/MongoDB_Logo_FullColorBlack_RGB-4td3yuxzjs.png" />](https://github.com/code-collabo/node-mongo-cli)
-->

## Contributors ✨

Thanks to these wonderful people helping to improve the ***node-mongo-cli*** project [= (emoji key) =>](https://allcontributors.org/docs/en/emoji-key)
Thanks to these amazing contributors to the node-mongo-cli project. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. See [emoji key](https://allcontributors.org/docs/en/emoji-key). Contributions of any kind welcome!

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/Ifycode"><img src="https://avatars.githubusercontent.com/u/45185388?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Obiagba Mary Ifeoma</b></sub></a><br /><a href="https://github.com/code-collabo/node-mongo-cli/commits?author=Ifycode" title="Code">💻</a> <a href="https://github.com/code-collabo/node-mongo-cli/commits?author=Ifycode" title="Documentation">📖</a> <a href="#infra-Ifycode" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-Ifycode" title="Maintenance">🚧</a> <a href="https://github.com/code-collabo/node-mongo-cli/pulls?q=is%3Apr+reviewed-by%3AIfycode" title="Reviewed Pull Requests">👀</a> <a href="#projectManagement-Ifycode" title="Project Management">📆</a> <a href="#ideas-Ifycode" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/IsraelObiagba"><img src="https://avatars.githubusercontent.com/u/14045379?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Israel Obiagba</b></sub></a><br /><a href="#mentoring-IsraelObiagba" title="Mentoring">🧑‍🏫</a></td>
<td align="center"><a href="https://github.com/jiobiagba"><img src="https://avatars.githubusercontent.com/u/42423547?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joseph Obiagba</b></sub></a><br /><a href="#mentoring-jiobiagba" title="Mentoring">🧑‍🏫</a></td>
<td align="center"><a href="https://github.com/Ifycode"><img src="https://avatars.githubusercontent.com/u/45185388?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Obiagba Mary Ifeoma</b></sub></a><br /><a href="https://github.com/code-collabo/node-mongo-cli/commits?author=Ifycode" title="Code">💻</a> <a href="https://github.com/code-collabo/node-mongo-cli/commits?author=Ifycode" title="Documentation">📖</a></td>
<td align="center"><a href="http://chuddyjoachim.com"><img src="https://avatars.githubusercontent.com/u/56943504?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chikezie Joachim</b></sub></a><br /><a href="https://github.com/code-collabo/node-mongo-cli/commits?author=chuddyjoachim" title="Code">💻</a></td>
<td align="center"><a href="https://allcontributors.org"><img src="https://avatars.githubusercontent.com/u/46410174?v=4?s=100" width="100px;" alt=""/><br /><sub><b>All Contributors</b></sub></a><br /><a href="#infra-all-contributors" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
</tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

See complete list of Code Collabo contributors in the [docs: all-contributors.md](https://github.com/code-collabo/docs/blob/main/all-contributors.md).

## Technologies

[<img alt="javascript" height="25px" src="https://www.freepnglogos.com/uploads/javascript/javascript-online-logo-for-website-0.png" />](https://github.com/code-collabo/node-mongo-cli)
[<img alt="node js" height="25px" src="https://nodejs.org/static/images/logos/nodejs-new-pantone-black.svg" />](https://github.com/code-collabo/node-mongo-cli)
[<img alt="mongoDB" height="25px" src="https://webassets.mongodb.com/_com_assets/cms/MongoDB_Logo_FullColorBlack_RGB-4td3yuxzjs.png" />](https://github.com/code-collabo/node-mongo-cli)
Empty file modified bin/create-node-mongo-project
100644 → 100755
Empty file.
4 changes: 0 additions & 4 deletions bin/customize-preinstall

This file was deleted.

1 change: 0 additions & 1 deletion contributing.md

This file was deleted.

1 change: 0 additions & 1 deletion contributor.md

This file was deleted.

68 changes: 68 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# node-mongo CLI

![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat) ![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg) ![GitHub issues](https://img.shields.io/github/issues/code-collabo/node-mongo-cli?color=red) ![GitHub pull requests](https://img.shields.io/github/issues-pr/code-collabo/node-mongo-cli?color=goldenrod)

**Supported node versions:** node v12.x to v16.x

The **node-mongo** project has 3 main projects:

* The node-mongo CLI to bootstrap boilerplate templates.
* 3 boilerplate templates for nodejs and/or mongoDB development.
* Demo CRUD app to test connection and show example usage of the templates.

## CLI Features

* CLI bootstraps the esm, cjs or ts templates for nodejs and/or mongoDB development.
* Install dependencies and intialize git for the template bootstrapped or choose to skip them.
* Folders are automatically created based on user entry in prompt or command-line.
* Default folder name is provided and incremented if name already exists.

## **CLI Installation**

Install **node-mongo-cli** globally with this command:

```text
npm install -g @code-collabo/node-mongo-cli
```

## Command

After installing globally, use the node-mongo command.

```text
node-mongo
```

### Usage

```text
node-mongo <folder_name> <template>
```

### Usage example

The example below will bootstrap the cjs template i.e. the common js template into a folder named test-folder.

```text
node-mongo test-folder cjs
```

### Flags

```text
-h, --help Show help
-i, --install Install dependencies
-g, --git Initialize git repo
-s, --skip-install Skip installing dependencies
-x, --skip-git Skip initializing git
-y, --yes See note on --yes flag below
```

### Prompts

If you do not specify one or both arguments above, you will be prompted to add your folder name and/or choose template option from list. For folder name, you can choose to use the default folder name provided in the prompt or type in your preferred folder name.

### Skip prompts

No prompt when --yes flag is used. It skips both install and git init, and uses esm template as default if no template is specified or if template entered is not in the template collection. In the case of folder name, default folder name is used if no folder name is specified or when folder name already exists.

20 changes: 20 additions & 0 deletions doc/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Table of contents

* [node-mongo CLI](README.md)
* [Boilerplate templates](boilerplate-templates.md)
* [Demo CRUD app](demo-crud-app.md)

## contribution guide

* [Contribution guidelines](https://code-collabo.gitbook.io/doc/collabo-guidelines/contributing)
* [Development mode](contribution-guide/development-mode.md)

## All contributors

* [All contributors](https://github.com/code-collabo/node-mongo-cli#contributors-)

## useful links

* [Release notes](https://github.com/code-collabo/node-mongo-cli/releases)
* [Report or fix issues](https://github.com/code-collabo/node-mongo-cli/issues)

Loading