gabrielmissio / task-manager-api

This is a full Serverless architecture project built using Test-Driven Development (TDD) principles. The API provides a simple and intuitive way to manage your tasks and stay organized.

TASK-MANAGER-API

Restful Nodejs API for easy task management! 🚀

Overview

Lorem Ipsum is simply dummy text of the printing and typesetting industry.

Stack

• Nodejs (v 14.17)
• npm (v 6.14)
• Docker
• Serverless Framework
• DynamoDB
• AWS lambda
• AWS-SDK
• Express
• Husky
• ESLint
• Jest
• Joi
• ...

Project anatomy

app
 └ __mocks__                        → Source folder for mock dependencies 
 └ __test__                         → Source folder for unit, integration and features tests
 └ .husky                           → Source folder for husky hook scripts
 └ my-dynamodb-data (generated)     → Dynamodb-Local data
 └ node_modules (generated)         → NPM dependencies
 └ src                              → Application sources 
    └ domain                           → Application services layer
       └ services                         → Application business rules 
    └ infra                            → Application infrastructure layer
       └ db                               → Application data handler
          └ dynamodb                         → Dynamodb implementation
             └ factories                        → Adapters between dynamodb data and application entities
             └ helpers                          → Dynamodb implementation helpers
             └ migrations                       → Module for creating and removing dynamodb tables
             └ repositories                     → Operation to put, read and remove data in dynamodb tables
             └ seeders                          → Module for inserting and removing data in dynamodb tables
       └ helpers                          → Infrastructure helpers
    └ main                             → Application main layer
       └ adapters                         → adpters
       └ config                           → config
       └ factories                        → Application component builders
       └ middlewares                      → middlewares
       └ routers                          → routes
    └ presentation                     → Application presentation layer
       └ controllers                      → Application requests handler
       └ errors                           → Presentation errors
       └ helpers                          → Presentation helpers
       └ validations                      → Request schema validations
    └ utils                            → Application utils
       └ enums                            → enums
       └ errors                           → errors
       └ helpers                          → helpers
       └ regular-expressions              → regular expressions
 └ index.js                         → Application entry point
 └ ...                              → Other files

Run Locally

Install dependencies

npm install

Initialize in-memory database

npm run start-dynamodb

Run tests

Unit Tests

npm run test-unit

Integration Tests

npm run test-integration

Feature Tests

npm run test-feature

Coverage Test ( performs all the above tests)

npm run test-coverage

Create tables

npm run start-dynamodb-migrations

Run seeders

npm run start-dynamodb-seeders

Start API

npm run start-dev

License

LICENSE