Skip to content

Final readme fix in preparation for publishing #114

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.

Sign up for GitHub

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

Merged
Ifycode merged 2 commits into from
Sep 29, 2021
Merged

Final readme fix in preparation for publishing #114

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
976aa6a
Update README.md
Ifycode Sep 28, 2021
2755a6e
Add want to contribute section, add links and fix header
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
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@
![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)

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
- Commonjs template
- [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.
- Two connection options to pick from: your installed mongoDB and mongoDBatlas.
- Demo CRUD app to test that your connection is setup and show example usage of the templates.
### 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:
Expand Down Expand Up @@ -58,16 +60,16 @@ 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.

### --yes flag
### 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
More about the node-mongo project in Code Collabo's documentation.
## 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.
Expand Down