borjapazr / express-typescript-skeleton Goto Github PK

🔰🦸 Template to start developing a REST API with Node.js (Express), TypeScript, Ts.ED, ESLint, Prettier, Husky, Prisma, etc.

Home Page: https://express-typescript-skeleton.bpaz.dev/api/docs

License: MIT License

JavaScript 7.53% Shell 0.49% Dockerfile 1.09% Makefile 2.16% TypeScript 88.72%

express nodejs typescript eslint prettier docker docker-compose dockerfile jest supertest

express-typescript-skeleton's Introduction

Node.js, Typescript and Express template

🔰🦸 Production-ready template for backends created with Node.js, Typescript and Express

ℹ️ About • 📋 Features • 🤝 Contributing • 🛣️ Roadmap • 🎯 Credits • 🚩 License

ℹ️ About

The main goal of this project is to provide a base template for the generation of a production-ready REST API made with Node.js, Express and Typescript. The idea is to avoid having to configure all the tools involved in a project every time it is started and thus be able to focus on the definition and implementation of the business logic.

📣 This is an opinionated template. The architecture of the code base and the configuration of the different tools used has been based on best practices and personal preferences.

🚀 Quick start

Install dependencies:
```
npm install
# or
make install
```
Start database container:
```
make start/db
```
Start cache container:
```
make start/cache
```
Generate Prisma Client:
```
npm run prisma:generate
```
Start project in development mode:
```
npm run dev
```
Start project in production mode:
```
npm run start
```

Open the following URL to interact with the API using Swagger UI:

http://localhost:5000/api/docs
# Sample username and password: janedoe / 123456

📋 Features

Built using Typescript
Built using Express Framework: Fast, unopinionated, minimalist web framework for node.
Built using Prisma: Next-generation ORM for Node.js & TypeScript | PostgreSQL, MySQL, MariaDB, SQL Server, SQLite & MongoDB
Built using Ts.ED: Ts.ED is a Node.js Framework on top of Express/Koa.js. Written in Typescript, it helps you build your server-side application easily and quickly. If you want to start a complete out-of-the-box project or fully customize it yourself, Ts.ED will guide you there!
JWT authentication and role based authorization using custom middleware
OpenAPI definition
Fully configured logger with Pino
Unit, Integration and E2E tests using Jest and Supertest
Linting with ESLint
Formatting with Prettier
Spell check
Git hooks with Husky and lint-staged
Containerised using Docker and Docker Compose
Path aliases support
Commit messages must meet conventional commits format
GitHub Actions
Makefile as project entrypoint
PostgreSQL as database
Redis as cache engine
A lot of emojis 🛸

🐐 Makefile rules

The main actions on this project are managed using a Makefile as an entrypoint.

Usage: make TARGET [ARGUMENTS]

Targets:
  build/docker              Build Docker image of the application
  clean/docker              Clean all container resources
  help                      Show this help
  install                   Install the project
  logs                      Show logs for all or c=<name> containers
  requirements              Check if the requirements are satisfied
  start                     Start application in development mode
  start/docker              Start application in a Docker container
  start/docker/cache        Start cache container
  start/docker/db           Start database container
  stop/docker               Stop application running in a Docker container
  stop/docker/cache         Stop cache container
  stop/docker/db            Stop database container

⚡ Scripts

package.json scripts:

dev: Start project in development mode
build: Build project and generate final build
start: Start project in production mode
check:types: Check if project types are correct
check:format: Check if project is formatted correctly
check:lint: Check if project is linted correctly
check:packagejson: Check if project package.json is correct
check:markdown: Check if markdown files are correct
check:spelling: Check if project is spelled correctly
fix:format: Fix project format issues
fix:lint: Fix project lint issues
fix:staged: Check and fix staged files
test: Run all tests
test:unit: Run unit tests
test:int: Run integration tests
test:e2e: Run e2e tests
test:watch: Run tests in watch mode
test:coverage: Run tests with coverage
coverage:view: Show coverage information
commit: Help to commit changes using conventional commits
version: Generate new project version
reset-hard: Reset git repository to a clean state
prepare-release: Prepare the project for a release and generates a new release
update-deps: Update the project dependencies

🤝 Contributing

Just fork and open a pull request. All contributions are welcome 🤗

🛣️ Roadmap

Please, check TODO for the current roadmap.

🎯 Credits

To implement this project I have based myself on many similar projects. There were countless of them and I gave them all a star.

🙏 Thank you very much for these wonderful creations.

⭐ Stargazers

🚩 License

MIT @ borjapazr. Please see License for more information.

express-typescript-skeleton's People

Contributors

Stargazers

Watchers

Forkers

gravinawilliam enrodroid abubakar-yinka claykabongok rondinellewalitte zsakuraevilz ftnt rafaelhz develmood wlater jetslambda shifeuxt nodexchange flavioandre dwisusanto29 felipebhz dookki darlanquimas delgerskhn jomarquez21 akmaldira hoaflee samthehai david0718 emretoprak samuelsankys edyonil pedroblandim xxx0204 ali-hazan tangjj1996 edu18rr kaayo valenn0101 tiafreninsweat bjmendezsena natividadcv guidoperman1986 pruiz05 chisoulcodes larstbone talesofthislife faeshal srikanthakula haihpse150218 abbasjafari-vu yurychang just-den quangtranvan8821 ab-sharifi21 toyogua nileshgarg0023 jonathanmanchego

express-typescript-skeleton's Issues

🚀 Feature: Add Redis cache to store user sessions

Bug Report Checklist

I have tried restarting my IDE and the issue persists.
I have pulled the latest main branch of the repository.
I have searched for related issues and found none that matched my issue.

Overview

Add Redis cache to store user sessions

Additional Info

No response

Prisma relations error

Hi,

First of all thank you for this complete project.

I'm currently having a problem using one-to-one relationships with Prisma.

It's probably due to a misunderstanding of the code on my part but I've been blocking for a while now.

I'm trying to create a relationship between an entity called Project with another called ProjectDrive.

This is the .prisma file entities declaration :

model Project {
  id                Int             @id @default(autoincrement())
  uuid              String          @unique @db.VarChar(1000)
  publicName        String          @db.VarChar(255)
  privateName       String          @db.VarChar(255)
  slug              String          @db.VarChar(255)
  description       String          @db.VarChar(500)
  projectDrive      ProjectDrive?
  createdAt         DateTime?       @default(now()) @db.Timestamptz(3)
  createdBy         String?         @db.VarChar(255)
  updatedAt         DateTime?       @default(now()) @updatedAt @db.Timestamptz(3)
  updatedBy         String?         @db.VarChar(255)
  deletedAt         DateTime?       @db.Timestamptz(3)
  deletedBy         String?         @db.VarChar(255)
}

model ProjectDrive {
  id                        Int                   @id                                   @default(autoincrement())
  uuid                      String                @unique                               @db.VarChar(1000)
  folderId                  String?               @unique                               @db.VarChar(500)
  name                      String?               @unique                               @db.VarChar(500)
  url                       String?               @db.VarChar(500)
  project                   Project?              @relation(fields: [puid], references: [uuid])
  puid                      String?               @unique
  createdAt                 DateTime?             @default(now())                       @db.Timestamptz(3)
  createdBy                 String?               @db.VarChar(255)
  updatedAt                 DateTime?             @default(now())                       @updatedAt                    @db.Timestamptz(3)
  updatedBy                 String?               @db.VarChar(255)
  deletedAt                 DateTime?             @db.Timestamptz(3)
  deletedBy                 String?               @db.VarChar(255)
}

After migrate and generate I got this error :

Type 'ProjectDriveModel' is not assignable to type '(Without<ProjectDriveCreateInput, ProjectDriveUncheckedCreateInput> & ProjectDriveUncheckedCreateInput) | (Without<...> & ProjectDriveCreateInput)'.
  Type 'ProjectDriveModel' is not assignable to type 'Without<ProjectDriveUncheckedCreateInput, ProjectDriveCreateInput> & ProjectDriveCreateInput'.
    Type 'ProjectDriveModel' is not assignable to type 'Without<ProjectDriveUncheckedCreateInput, ProjectDriveCreateInput>'.
      Types of property 'id' are incompatible.
        Type 'number' is not assignable to type 'undefined'.

I understand why it failed in the code :

ProjectDriveModel generated by prisma :

export declare class ProjectDriveModel implements ProjectDrive {
    id: number;
    uuid: string;
    folderId: string | null;
    name: string | null;
    url: string | null;
    project: ProjectModel | null;
    puid: string | null;
    createdAt: Date | null;
    createdBy: string | null;
    updatedAt: Date | null;
    updatedBy: string | null;
    deletedAt: Date | null;
    deletedBy: string | null;
}

ProjectDriveCreateInput :

export type ProjectDriveCreateInput = {
    uuid: string
    folderId?: string | null
    name?: string | null
    url?: string | null
    project?: ProjectCreateNestedOneWithoutProjectDriveInput
    createdAt?: Date | string | null
    createdBy?: string | null
    updatedAt?: Date | string | null
    updatedBy?: string | null
    deletedAt?: Date | string | null
    deletedBy?: string | null
}

ProjectDriveUncheckedCreateInput :

export type ProjectDriveUncheckedCreateInput = {
    id?: number
    uuid: string
    folderId?: string | null
    name?: string | null
    url?: string | null
    puid?: string | null
    createdAt?: Date | string | null
    createdBy?: string | null
    updatedAt?: Date | string | null
    updatedBy?: string | null
    deletedAt?: Date | string | null
    deletedBy?: string | null
  }

It seems that ProjectDriveModel is in conflict with ProjectDriveUncheckedCreateInput on the id field, but I checked if I remove the relation those files are the same, and I got no errors.

I'm really out of ideas, if you can help me 🙏🏼

Tell me if it's not clear or if you need more explanations !

Thank you !

💡 Discussion: Vertical Slice Architecture

Feature Request Checklist

I have pulled the latest main branch of the repository.
I have searched for related issues and found none that matched my issue.

Overview

This is more of a discussion than a feature request.

What do you think about organizing the features using the architecture that is commonly known as "Vertical Slice architecture"?

The current structure is:

application
- feature1
- ...
domain
- feature1
- ...
infrastructure
- feature1
- ...
presentation
- ...

The proposed structure would organize every logic of a feature in a feature folder:

features
- feature1
  - application
  - domain
  - infrastructure
  - presentation
  - ...
domain (common shared domain logic)
application (common shared application logic)
infrastructure (...)
presentation (generic logic where each feature will register it's presentation components)

I think this will improve cohesion and reduce coupling by setting clear features boundaries. Each boundary can specify exactly what should be shared with other parts of the system. Having each logic of a feature in a feature root folder will also help when traversing the code and learning about what the feature has implemented.

References

https://www.jimmybogard.com/vertical-slice-architecture/

Additional Info

No response

Improve logger

The current logger can be modified to improve the developer's experience in detecting potential problems or bugs.

Remove color characters from log files when there is a compilation error. This is caused by ts-node and the --pretty property (TS_NODE_PRETTY)
Evaluate the use of other logging libraries (pino, @tsed/logger, log4js, etc.)
Add a correlation id to all logs of the same request

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

asdf

.tool-versions

node 20.11.1

docker-compose

docker/docker-compose.yml

postgres 16

redis 7

dockerfile

docker/Dockerfile

docker/dockerfile 1.6-labs

node 20.11.1-alpine

github-actions

.github/actions/setup-environment/action.yml

asdf-vm/actions v3

actions/cache v4

asdf-vm/actions v3

actions/cache v4

.github/workflows/cd.yml

actions/checkout v4

softprops/action-gh-release v1

actions/checkout v4

docker/login-action v3

docker/metadata-action v5

docker/build-push-action v5

.github/workflows/ci.yml

actions/checkout v4

actions/checkout v4

actions/checkout v4

npm

package.json

@ngneat/falso ^7.2.0

@prisma/client ^5.10.2

@tsed/ajv ^7.62.2

@tsed/common ^7.62.2

@tsed/components-scan ^7.62.2

@tsed/core ^7.62.2

@tsed/di ^7.62.2

@tsed/exceptions ^7.62.2

@tsed/ioredis ^7.62.2

@tsed/json-mapper ^7.62.2

@tsed/logger ^6.6.3

@tsed/openspec ^7.62.2

@tsed/platform-express ^7.62.2

@tsed/prisma ^7.62.2

@tsed/schema ^7.62.2

@tsed/swagger ^7.62.2

ajv ^8.12.0

argon2 ^0.40.1

body-parser ^1.20.2

compression ^1.7.4

cookie-parser ^1.4.6

cors ^2.8.5

dotenv-defaults ^5.0.2

dotenv-expand ^11.0.6

endent ^2.1.0

express 4

fast-equals ^5.0.1

figlet ^1.7.0

file-stream-rotator ^1.0.0

http-status-codes ^2.3.0

ioredis ^5.3.2

jsonwebtoken ^9.0.2

just-is-empty ^3.4.1

luxon ^3.4.4

method-override ^3.0.0

multer 1.4.5-lts.1

node-emoji ^2.1.3

pino ^8.19.0

pino-http ^9.0.0

pino-pretty ^10.3.1

reflect-metadata ^0.2.1

source-map-support ^0.5.21

ts-node ^10.9.2

uuid ^9.0.1

@commitlint/cli ^19.0.3

@commitlint/config-conventional ^19.0.3

@cspell/dict-bash ^4.1.3

@cspell/dict-companies ^3.0.31

@cspell/dict-es-es ^2.4.0

@cspell/dict-filetypes ^3.0.3

@cspell/dict-html ^4.0.5

@cspell/dict-lorem-ipsum ^4.0.0

@cspell/dict-node ^4.0.3

@cspell/dict-npm ^5.0.15

@cspell/dict-software-terms ^3.3.18

@cspell/dict-typescript ^3.1.2

@tsed/cli-plugin-prisma ^5.1.0

@types/body-parser ^1.19.5

@types/compression ^1.7.5

@types/cookie-parser ^1.4.7

@types/cors ^2.8.17

@types/dotenv-defaults ^2.0.4

@types/express ^4.17.21

@types/figlet ^1.5.8

@types/jest ^29.5.12

@types/jsonwebtoken ^9.0.6

@types/luxon ^3.4.2

@types/method-override ^0.0.35

@types/multer ^1.4.11

@types/node ^20.11.24

@types/node-emoji ^1.8.2

@types/source-map-support ^0.5.10

@types/supertest ^6.0.2

@types/swagger-schema-official ^2.0.25

@types/uuid ^9.0.8

@typescript-eslint/eslint-plugin ^7.1.0

@typescript-eslint/parser ^7.1.0

commitizen ^4.3.0

copyfiles ^2.4.1

cross-env ^7.0.3

cspell ^8.5.0

cz-conventional-changelog ^3.3.0

eslint ^8.57.0

eslint-config-airbnb-base ^15.0.0

eslint-config-airbnb-typescript ^18.0.0

eslint-config-prettier ^9.1.0

eslint-import-resolver-typescript ^3.6.1

eslint-plugin-deprecation ^2.0.0

eslint-plugin-eslint-comments ^3.2.0

eslint-plugin-hexagonal-architecture ^1.0.3

eslint-plugin-import ^2.29.1

eslint-plugin-jest ^27.9.0

eslint-plugin-jest-extended ^2.0.0

eslint-plugin-jsonc ^2.13.0

eslint-plugin-markdown ^3.0.1

eslint-plugin-n ^16.6.2

eslint-plugin-optimize-regex ^1.2.1

eslint-plugin-prefer-arrow ^1.2.3

eslint-plugin-prettier ^5.1.3

eslint-plugin-promise ^6.1.1

eslint-plugin-security ^2.1.1

eslint-plugin-simple-import-sort ^12.0.0

eslint-plugin-sonarjs ^0.24.0

eslint-plugin-unicorn ^51.0.1

eslint-plugin-unused-imports ^3.1.0

eslint-plugin-yml ^1.12.2

get-tsconfig ^4.7.2

http-server ^14.1.1

husky ^9.0.11

ioredis-mock ^8.9.0

is-ci ^3.0.1

jest ^29.7.0

jest-extended ^4.0.2

jest-mock-extended ^3.0.5

lint-staged ^15.2.2

markdownlint ^0.33.0

markdownlint-cli ^0.39.0

nodemon ^3.1.0

npm-check-updates ^16.14.15

npm-package-json-lint ^7.1.0

npm-package-json-lint-config-default ^6.0.0

npm-run-all2 ^6.1.2

prettier ^3.2.5

prettier-plugin-packagejson ^2.4.12

prettier-plugin-prisma ^5.0.0

prisma ^5.10.2

rimraf ^5.0.5

standard-version ^9.5.0

supertest ^6.3.4

ts-jest ^29.1.2

tsc-alias ^1.8.8

tsconfig-paths ^4.2.0

tsx ^4.7.1

typescript ^5.3.3

yaml-eslint-parser ^1.2.2

node >=20.9.0

npm >=6.7.0

Check this box to trigger a request for Renovate to run again on this repository

INJECTION_ERROR: Injection failed on ValidationPipe > Ajv

Environment:

computer: macbook pro
os: MacOS Monterey
node version: v18.12.1
npm version: v8.19.2
yarn version: 1.22.18

To reproduce:

git checkout v2.2.2
git switch -c dev
yarn
yarn prisma:generate
yarn run dev

Then I get the output:

[2023-01-07 03:07:11.711] ERROR uncaughtException: Injection failed on ValidationPipe > Ajv
Origin: Cannot read properties of undefined (reading 'code')
INJECTION_ERROR: Injection failed on ValidationPipe > Ajv
Origin: Cannot read properties of undefined (reading 'code')
at Function.throwInjectorError (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/errors/InjectionError.ts:44:11)
at InjectorService.resolve (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:640:22)
at InjectorService.invoke (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:211:21)
at InjectorService.loadSync (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:264:14)
at InjectorService.load (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:336:10)
at async PlatformBuilder.loadInjector (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/common/src/builder/PlatformBuilder.ts:202:5)
at async PlatformBuilder.runLifecycle (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/common/src/builder/PlatformBuilder.ts:189:5)
at async start (/Users/zhangjie/Work/express-typescript-skeleton/src/index.ts:13:20) INJECTION_ERROR: Injection failed on ValidationPipe > Ajv
Origin: Cannot read properties of undefined (reading 'code')
at Function.throwInjectorError (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/errors/InjectionError.ts:44:11)
at InjectorService.resolve (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:640:22)
at InjectorService.invoke (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:211:21)
at InjectorService.loadSync (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:264:14)
at InjectorService.load (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/di/src/services/InjectorService.ts:336:10)
at async PlatformBuilder.loadInjector (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/common/src/builder/PlatformBuilder.ts:202:5)
at async PlatformBuilder.runLifecycle (/Users/zhangjie/Work/express-typescript-skeleton/node_modules/@tsed/common/src/builder/PlatformBuilder.ts:189:5)
at async start (/Users/zhangjie/Work/express-typescript-skeleton/src/index.ts:13:20)
[nodemon] clean exit - waiting for changes before restart

borjapazr / express-typescript-skeleton Goto Github PK

express-typescript-skeleton's Introduction

🔰🦸 Production-ready template for backends created with Node.js, Typescript and Express

ℹ️ About

🚀 Quick start

📋 Features

🐐 Makefile rules

⚡ Scripts

🤝 Contributing

🛣️ Roadmap

🎯 Credits

⭐ Stargazers

🚩 License

express-typescript-skeleton's People

Contributors

Stargazers

Watchers

Forkers

express-typescript-skeleton's Issues

Bug Report Checklist

Overview

Additional Info

Feature Request Checklist

Overview

References

Additional Info

Rate-Limited

Open

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org