Skip to content

Latest commit

 

History

History
127 lines (87 loc) · 3.55 KB

README.md

File metadata and controls

127 lines (87 loc) · 3.55 KB
Raw

Overview

This is a back-end clean architecture project designed with the following technologies:

  node -v
  # v16+
  tsc -v
  # version 4.4.+

Summary

Directory structure
-- src/
---- app/
---- infra/
---- interfaces/

Setup and Install

Steps to setup everything is simple 4 steps to do, follow the steps below:

1º - Git Clone

In your terminal go in the directory where you want to clone the project

git clone https://github.com/kevingamaa/typescript-backend-example.git
2º - Environment

you will notice that we have the .env.example file in the root directory, create another file named .env, and copy and paste the content from env.example in your .env file. It's something like this.

APP_NAME='Back-end example'
APP_LOGS=true

MYSQL_PORT=3306
MYSQL_HOST='db'
MYSQL_DATABASE='app'
MYSQL_USERNAME='root'
MYSQL_PASSWORD='example'
3º - Dependencies

The project is decoupled from any third parties libraries, so if you decide to work with another logging library or database ORM the choice is up to you, in case yes go ahead and adjust the dependencies and create the adapters for whatever you integrating with. In the meanwhile, we're working with typeorm as our ORM, express to provide an HTTP interface and pinno for logging. Finally to install everything you run:

npm install
4º - Build and Running

If you're here I'll guess everything went great and you only need to get the project running for that go ahead and run the script below in your terminal:

npm start:dev

after your application started you should check if the localhost:3000 or localhost:3200 receive the response "hello world"

Production

It would be the following commands

npm run build

and then

npm start

docker setup

In case you prefer to use docker, there is a docker-compose file binding everything you need to get the project running

docker compose up

!!!Remember in case of using docker every command should be executed inside the container!!!

Logging

In case you need to visualize better your terminal output if you're using Pino as your logging tool just install pino-pretty with the following command:

npm install --save-dev pino-pretty

and then in the src/main.ts file, you edit the line creating your application with the following configuration for pretty log

  const app = await ApplicationFactory.createHttpApplication({
    logger: {
      engine: "pino",
      pinoOptions: {
        transport: {
          target: "pino-pretty", // this will load pino pretty
        },
      },
    },
    ...
  })

Database

The following commands for database connection was implemented with typeorm, if you feel that you should be using a different ORM go ahead and change, but would be necessary to config the CLI for your setup.