Skip to content

jwright04/swagger-node-mongo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

travis build codecov semantic-release MIT licensed

Swagger.io - NodeJS - MongoDB Starter

Additional Dependencies

Installation

git clone https://github.com/jwright04/swagger-node-mongo.git
npm install
npm start

Commiting your code

Traditionally, after adding your code, you'd do something like:

git commit -m "added some new functionality bla bla bla"

Commitizen offers a standardized format for your commit messages. After adding your code, you'd run the following command.

npm run commit

Select the type of change that you're commiting and push your code back to the repo like you'd normally do: More info here

Test (this happens automatically with TravisCI)

Important: Make sure mongoDB is running locally before running tests.

npm test

What's going on here?

####Swagger.io... ...is an open source framework that allows you to "design, build, document, and consume your RESTful APIs."

####Node... ..."is a JavaScript runtime built on Chrome's V8 JavaScript engine." - NodeJS.org

####MongoDB... ...is a "document oriented database program". Also known as a "NoSQL" database program

Perfect For

  • Hackathons to get up and running quick
  • Project Starters

Lastly...

I'm never too busy, if you have any questions, concerns, or ideas for improvements, feel free to open an issue, submit a PR or reach out to me directly.