One of the most time-consuming tasks when starting a project from scratch is the creation of the initial scaffolding, the folder structure, the configuration of linters and formatters, the configuration of tests, etc. They are almost always the same tasks, changing certain details to adapt them to the team's development conventions. On the other hand, there are also common tasks in most projects, such as for example, authentication and/or authorization and user management, the definition of the OpenAPI specification, creation of a common logger, etc. Because of this, I decided to create a base template of a created with , using as the base framework and as the programming language. This template tries to follow the principles of and implements a to try to rely as little as possible on the infrastructure and the framework while keeping in mind at all times the language and the needs of the business logic. REST API NodeJS Ts.ED TypeScript Domain Driven Design Clean Architecture/Hexagonal Architecture 📣 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. 🧰 Technologies and tools used Built using Typescript Built using : Fast, unopinionated, minimalist web framework for node. Express Framework Built using : Next-generation ORM for Node.js & TypeScript | PostgreSQL, MySQL, MariaDB, SQL Server, SQLite & MongoDB Prisma Built using : 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! Ts.ED This framework is extremely powerful and easy to use. It is really worth it. JWT authentication and role-based authorization using custom middleware OpenAPI definition Fully configured logger with and Winston Morgan Unit, Integration, and E2E tests using and Jest Supertest Linting with ESLint Formatting with Prettier Spell check Git hooks with and Husky lint-staged Containerized using and Docker Docker Compose Path aliases support Commit messages must meet the format of the conventional commit GitHub Actions Makefile as the project entry point A lot of emojis 🛸 🚀 Quick start Create a project from this template on or clone it directly GitHub git clone https://github.com/borjapazr/express-typescript-skeleton.git Install dependencies npm install Start and configure the database using Prisma make start/db # This step will create a Docker container with the database (MariaDB). It may take some time, so be patient before running the next command.
npm run prisma:generate
npm run prisma:migrate
npm run prisma:seed Start project in development mode: npm run dev Open the following URL to interact with the API using Swagger UI: http://localhost:5000/api/docs # Sample username and password: janedoe / 123456 Or, if you prefer, you can access the demo version. https://express-typescript-skeleton.marsmachine.space/api/docs
# Sample username and password: janedoe / 123456 🤝 Contributing Just fork and open a pull request. All contributions are welcome 🤗 GitHub repository: https://github.com/borjapazr/express-typescript-skeleton Thank you for taking the time to read this post. You rock! 🤘

The writer is smart, but don't just like, take their word for it. #DoYourOwnResearch

The code in this story is for educational purposes. The readers are solely responsible for whatever they build with it.

Facebook

How to Get Started With a Clean Architecture Template for NodeJS, Ts.ED and TypeScript

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

5 Essential Software Architecture Design Principles

A Beautiful Architecture of Server-Side Alarm

A Deeper Look into Clean Architecture: Flutter vs Kotlin

An Introductory Guide to Monolith Software Applications

How to Organize CLEAN ARCHITECTURE to Modular Patterns in 10 Minutes

Building an API in Rust with Rocket.rs and Diesel.rs Following Clean Architecture

5 Essential Software Architecture Design Principles

A Beautiful Architecture of Server-Side Alarm

A Deeper Look into Clean Architecture: Flutter vs Kotlin

An Introductory Guide to Monolith Software Applications

How to Organize CLEAN ARCHITECTURE to Modular Patterns in 10 Minutes

Building an API in Rust with Rocket.rs and Diesel.rs Following Clean Architecture

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps