isaacdecoded / arpeggio-ts

Coding template for DDD and Clean Architecture based projects on TypeScript.

ARPEGGIO ON TYPESCRIPT

This is the Arpeggio coding template based on TypeScript.

Requirements

• NodeJS
• Yarn

Scripts

You can run it by executing the commonly known NodeJS scripts commands:

yarn install
yarn build
yarn start

For development purposes, you may want to use the following script commands in separate terminal screens:

yarn build:watch
yarn start:watch

Execute tests by using the Jest included library:

yarn test

Dependencies

Arpeggio on TypeScript keeps the codebase clean by including only the module-alias dependency. This dependency can be removed if the user does not require simplified import paths with aliases. If you decide to keep the aliases, please remember that their usage depends on the following configurations:

1. In tsconfig.json, include your paths in the compilerOptions.paths object.
2. In package.json, include the same paths in the _moduleAliases object.
3. In jest.config.json, include the same paths in the moduleNameMapper object.

Additionally, Arpeggio on TypeScript includes a comprehensive suite of development and testing dependencies for coding styling, commit checking, and unit testing:

• Jest for unit tests
• Commitlint for pre-commit hook checks
• ESLint, lint-staged, Prettier, and Husky for code linting features
• nodemon for hot reloading during code development
• tslib for including the TypeScript helper functions

The Plan Concept example

You can take a look to the example by visiting the plan-concept-example branch