README.md

TODO App API RESTFUL

Table of Contents

• Installation
• Usage
• Dependecies
• Dev dependecies
• Support
• Contributing
• History
• License

Installation

• Clone this repo: git clone https://github.com/nando-experiments/todo-api-node.git && cs ./todo-api-node
• Install dependencies: yarn install # or npm install
• Start your mongodb: mongod
• Start this application: yarn dev # or npm run dev

Usage

Resources

Request

GET /

Example:

curl -X GET http://localhost:3003/api/todos

Return data with all motivational quotes

[
  {
    "done": false,
    "_id": "5c97bc4d1524badf255f5277",
    "description": "nonn ononono non no onononono",
    "createdAt": "2019-03-24T17:20:13.972Z",
    "__v": 0
  },
  {
  ...
]

Dependecies

• body-parser - Node.js body parsing middleware
• express - Fast, unopinionated, minimalist web framework
• mongoose - Mongoose MongoDB ODM
• node-restful - A library for making REST API's in node.js with express
• pm2 - Production process manager for Node.JS applications with a built-in load balancer.

Dev dependecies

• nodemon - Simple monitor script for use during development of a node.js app.

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request. Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

History

See Releases for detailed changelog.

Author

Fernando Moreira

License

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

Code is under MIT License - © Fernando Moreira

Buy me a coffee?

It will encourage me to keep it going, fix whatever bugs you find and spend time making it better :D