Basic Typescript Project

This is a project to help beginners to start a new project using typescript

The principles of the project

• Provide a basic project structure
• A functional ORM integration
• Use of Migrations to versioning the database
• Integration Tests
• Sonar/lint to help the code quality and legibility
• Be easy to test locally
• Documentation to help beginners

Project Structure

src

• config contains the project configuration, it's used to dotenv to populate the environment variables, note: explict declared variables overwrite any .env variable;

• database contains the migrations and the database creation logic, the migrations-as-code-example are ignored by default, if you want to use a code migration, you have to create in the migrations folder;

• entity The entities are direct representations of your database tables, there is a need to ignore cyclical dependencies because of the tables relations;

• logger contains the logger creation logic, there two behaviours, when debug is on, the log adopt a console friendly format, when debug is off assumes the default output, is possible to define another format, like elastic search format;

• repository contains the interaction with entities logic, will be used by the services to store and retrieve data in the databases;

• service contains the business logic

tests

• integration Contain tests that uses multiples parts of the project, even the entire project

About the tech choices

git-cz

Normalize commit tool with emojis 😍, very useful to make sure all your contributors are following the same pattern of commit message

Dotenv

Based on the Twelve-factor methodology, we try to keep our config on the environment, it's recommended that you use the environment variable of your cloud provider

Eslint + Prettier + Airbnb config

Helps to have a nice code readability, with a large use standard like the airbnb

Jest

An easy-to-go test framework and developed by Facebook, a valid alternative is Mocha, a more modular and smaller minzipped framework.

MySQL

Just by example, it's possible to change to any of the TypeORM supported databases

NVM

Avoid problems by the node and npm versions setting a static version on .nvmrrc

Testcontainers

It's a simple way to create a more reliable test creating docker containers during the test

TypeORM

it's a great ORM that uses the advantages of typescript like the decorators(like annotations from Java)

Winston

Great logger library, it's pretty easy to integrate with ELK using the extension winston-elasticsearch