Welcome to our project!

Overview

This project pretends to be an npm package to create a folder structure for a node typescript server using expressJS implementing clean architecture

How to use it

run npx folderforge start-project to create the base structure of the project then you'll be able to add modules using npx folderforge add-module -n <module-name>

Example

1. npx folderforge start-project
2. npx folderforge add-module -n users
3. npx folderforge add-module -n products
4. npx folderforge add-module -n orders

Folder Structure

This will be the result

• src

  • core

    • config
    • middlewares
    • modules
    • routing
    • services
  • modules

    • users

      • data

        • datasource
          • pg_data_source.ts
        • interfaces
          • users_data_source.ts
        • utils
      • domain

        • models
          • users_model.ts
        • repositories
          • users_repository.ts
          • users_repository_implementation.ts
      • presentation

        • users_middlewares.ts
        • users_router.ts
        • index.ts

    • ...

• node_modules
• package-lock.json
• package.json
• tsconfig.json

TODOs

• Implement CustomError types
• Implement presentation layer

Colaborators

• Manu "El Father" Ortigoza
• Manu "Tiro Largo" Castelnovo
• Santi "El Papa" Racca
• Fer "Chorizo Misionero" Mellone

Happy Coding!