β‘ Start your Node.js project with Typescript using Test Driven Development (TDD) practices.
This GitHub Actions workflow automatically builds and tests the application when code changes are pushed to the master branch or a pull request targeting the master branch is opened or synchronized.
To get started with this template, you first need to clone the repository:
git clone https://github.com/AraManjon/typescript-tdd-template.git
Then, install the project dependencies:
npm install
To start the server in development mode, run the following script:
npm run dev
Then, open http://localhost:8000 to access the server.
To run the server in production mode, first build the TypeScript code into JavaScript by running:
npm run build
This will generate the dist directory with the compiled JavaScript files.
Then, start the server by running:
npm start
This will start the server and make it available at http://localhost:8000.
This project comes with several predefined scripts in the package.json file:
test
: Runs tests using Jest.
lint
: Runs ESLint to check code quality.
lint:fix
: Runs ESLint to fix code style issues.
dev
: Starts the development server with ts-node-dev and allows debugging
build
: Removes the ./dist folder and compiles the TypeScript code into JavaScript in the ./dist folder.
start
: Starts the server in production using the compiled files in the dist/ folder.
-
cors: middleware for handling Cross-Origin Resource Sharing (CORS)
-
dotenv: loads environment variables from a .env file
-
express: web framework for Node.js
-
express-promise-router: promise-based router for Express
-
helmet: middleware for adding security headers
-
mongodb: driver for MongoDB
-
mysql2: MySQL client for Node.js
-
@types/cors: TypeScript definitions for cors
-
@types/express: TypeScript definitions for express
-
@types/jest: TypeScript definitions for jest
-
@types/mysql: TypeScript definitions for mysql
-
eslint: linter for TypeScript
-
eslint-config-codely: ESLint configuration used by CodelyTV
-
mysql: MySQL driver for Node.js
-
rimraf: cross-platform tool for removing files and directories
-
ts-jest: TypeScript preprocessor for Jest
-
ts-node-dev: TypeScript execution and development environment for Node.js
-
tsc-watch: TypeScript compiler with file watching
In this folder structure, the code is organized according to the principles of Hexagonal Architecture.
src/
βββ backend
β βββ middlewares
β βββ App.ts
β βββ server.start.ts
β βββ Server.ts
βββ shared
β βββ utils
β βββ domain
β βββ infrastructure
β βββ config
β βββ persistence
βββ user
βββ application
β βββ services
β βββ use-cases
βββ domain
β βββ entities
β βββ repositories
βββ infrastructure
βββ controllers
βββ repositories
βββ routes
βββ services
βββ UserModule.ts