USERS SERVICES

An Node JS supercool REST API to administrate users

The idea was to build an REST API in Node JS using best practices, patterns and frameworks that can be used in an enterprise application.

TODOs

• Refactor to use promises and validate
• Refactor to use async and validate
• Integration Test for repositories
• Clean up database before End to End tests

USER entity

{
    "_id": "7d092a2c-1d4f-498a-9fb7-c3a939f4c6a3",
    "email": "[email protected]",
    "name": "Jack Daniels",
    "createdAt": "2018-11-06T22:57:00.000Z"
}

Documentation:

access: http://localhost:3000 or doc.raml

For this, was used:

Architecture:

• The Clean Architecture

Design patterns:

• Revealing Module Pattern
• Dependency Injection
• Error-First Callbacks
• REST API Design Patterns

Java Script:

• JavaScript Standard Style

Application Frameworks:

• Express JS

Testing Strategies

• Testing Strategies in a Microservice Architecture
• Test Driven Development

Testing Frameworks:

• Mocha
• Chai

Code quality tools:

• ESlint
• pre-push

Package manager:

• npm

Running:

• clone the repository
• "docker-compose up" in main directory
• "npm install" to install dependencies
• "npm start" to start the application
• "npm test" to run @unit and @component tests
• "npm test -- --grep @unit", to run only unit tests
• "npm test -- --grep @component", to run only component tests
• "npm test -- --grep @e2e", ro run only end to end tests
• "npm run lint-js" to lint js files

Refencences:

• https://www.nodejsdesignpatterns.com/
• https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html
• https://toddmotto.com/mastering-the-module-pattern/
• http://fredkschott.com/post/2014/03/understanding-error-first-callbacks-in-node-js/
• http://expressjs.com/
• https://mochajs.org/
• http://chaijs.com/
• https://www.npmjs.com/
• https://github.com/standard/standard
• https://github.com/dflourusso/pre-push
• https://github.com/eslint/eslint