https://github.com/borgert-inc/express-api-startkit

API Startkit for node - express 4 + mongodb + eslint
https://github.com/borgert-inc/express-api-startkit

api api-node boilerplate eslint express husky mongodb mongoose nodejs

Last synced: about 1 month ago
JSON representation

API Startkit for node - express 4 + mongodb + eslint

• Host: GitHub
• URL: https://github.com/borgert-inc/express-api-startkit
• Owner: borgert-inc
• Created: 2018-06-07T18:12:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T02:42:13.000Z (almost 2 years ago)
• Last Synced: 2023-03-07T18:55:29.525Z (almost 2 years ago)
• Topics: api, api-node, boilerplate, eslint, express, husky, mongodb, mongoose, nodejs
• Language: JavaScript
• Homepage:
• Size: 272 KB
• Stars: 12
• Watchers: 2
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        



	

    


        Express API StartKit

    

    




[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a5bbca0e074745f4813552055c867b5d)](https://www.codacy.com/gh/borgert-inc/express-api-startkit/dashboard?utm_source=github.com&utm_medium=referral&utm_content=borgert-inc/express-api-startkit&utm_campaign=Badge_Grade)

---

#### Nodemon

> npm install -g nodemon

#### Install packages

> npm install

#### Copy .ENV

> cp .env-example .env

#### Configure .env

> MONGO_DB=mongodb://localhost:27017/mongo_db

#### Development (With nodemon watch .js)

> npm run dev

> http://localhost:3000

#### Eslint

> npm run eslint

#### Slack

  - Get your legacy token https://api.slack.com/legacy/custom-integrations/legacy-tokens

  - Documentation and methods for slack https://api.slack.com/methods

#### Insomnia

Use Insomnia to test the API endpoints, use the insomnia.json file that already has all the necessary endpoints. [Download Insomnia](https://insomnia.rest/).

#### Node Best Practices

> https://github.com/goldbergyoni/nodebestpractices

#### Routes

| Module    | Action    | Method    | Endpoint |

| :-----    | :------   | :-------  | :---------------------------------------------------------- | 

| Register  | Create    | POST      | http://localhost:3000/register |

| Login     | Login     | POST      | http://localhost:3000/auth/login |

| Logout    | Logout    | POST      | http://localhost:3000/auth/logout |

| Users     | All       | GET       | http://localhost:3000/users | 

| Users     | Create    | POST      | http://localhost:3000/users |

| Users     | Update    | PUT       | http://localhost:3000/users/:id |

| Users     | Show      | GET       | http://localhost:3000/users/:id |

| Users     | Delete    | DELETE    | http://localhost:3000/users/:id |

#### Packages

| Package                   | Description                                                |

| :------------------------- | :---------------------------------------------------------- | 

| bcryptjs                  | Encrypt password  |

| debug                     | For Debug    |

| dotenv-extended           | To work files .env    |

| eslint                    | Code standard    |

| express                   | Framework express    |

| consign                   | For load modules    |

| http-errors               | Controllers http errors     |

| method-override           | Overrise methods in express     |

| moment                    | To work with dates     |

| mongoose                  | ODM for database MongoDB    |

| mongoose-paginate-v2      | Paginate for mongoose    |

| mongoose-validator        | Validator inputs for mongoose    |

| winston                   | Logs generator    |