Express and Typescript

ExpressJs with TypeScript as a starter template

Used in ...

• Expressjs
• TypeScript
• Morgan
• Dotenv

# Install or setup a Database

## Choose and implement yourself

1. MongoDB with mongoose ODM

2. SQL/MySQL/Postgres/MSSQL with Prisma ORM or TypeORM

# Setup MongoDB as your database

Install mongoose for mongodb

$ yarn add:mongo

Very First, you need to add DATABASE_URL in .env (Actually the connection string).

DATABASE_URL=mongodb://username:password@hostname:dbport/dbname

Then, create a file ./src/configs/db.ts and write in this

// adding mongodb with mongoose
export const connectMongoDB() {
  // your connection setup code here
}

First in ./src/configs/index.ts

// exporting from this namespace
export * from './db';

Then setup this in ./src/server.ts

// import first
import {
  mode,
  port,
  connectMongoDB  // imported ...
} from './configs';
-------------------------------------
/// setup your database in here .....
await connectMongoDB()
.then(() => log.info(`MongoDB is connected :emoji:`))
.catch(err => log.error(err))

# Setup SQL based databases

Very First, you need to add DATABASE_URL in .env (Actually the connection string).

DATABASE_URL=postgresql://username:password@hostname:dbport/dbname

or

DATABASE_URL=mysql://username:password@hostname:dbport/dbname

You can add others if your want (like mssql, oracle, etc.)

Now you can choose Prisma or TypeORM. I would like to show Prisma first.

Note: TypeORM will be added later as documentation in here

Install Prisma ORM by executing this below

$ yarn add:prisma

Then it will install prisma as devDepencies and will install @prisma/client itself as dependency.

Now, you need to go ./src/prisma and must see your .schema file there. It will be your prisma config and database design/modeling etc.

After that, you can @prisma/client to query and make services with it.

As example for a user create and get service would like this

in ./src/prisma/prisma.schema

model User {
  id Int @id @default(autoincrement())
  name String
  email String @unique
  password String
}

now make user service in ./src/services/user.service.ts

CREATE :=> create user example

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

async function main() {
  const user = await prisma.user.create({
    data: {
      name: 'Alice',
      email: '[email protected]',
    },
  });
  console.log(user);
}

main()
  .then(async () => {
    await prisma.$disconnect();
  })
  .catch(async (e) => {
    console.error(e);
    await prisma.$disconnect();
    process.exit(1);
  });

GET :=> Find users example

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

async function main() {
  const users = await prisma.user.findMany();
  console.log(users);
}

main()
  .then(async () => {
    await prisma.$disconnect();
  })
  .catch(async (e) => {
    console.error(e);
    await prisma.$disconnect();
    process.exit(1);
  });

**If you find and hard or want to see prisma original documentation or example ** https://github.com/prisma/prisma-examples/tree/latest/typescript/rest-express

Let's see TypeORM setup from here

Execute this first to install TypeOrm.

$ yarn add:typeorm

It will add typeorm and reflect-metadata initially. But we need to choose database just after this. Then also install thier driver package like. For MySQL,

$ yarn add mysql
# or
$ yarn add mysql2 # latest

or

For PostgreSQL,

$ yarn add pg

Then you need create a ./src/configs/db.ts file. And put this configuation file for TypeORM and customize as you need.

import { DataSource } from 'typeorm';
import 'reflect-metadata'; // typeorm requires it

// you can also import values from `./env.ts` and put them in this configuation

export const setupTypeOrm = new DataSource({
  type: 'mysql', // database type
  host: 'localhost', // database hostname
  port: 3306, // database port
  username: 'test', // database username
  password: 'test', // database password
  database: 'test', // database name
  entities: ['src/**/*.entity.ts'], // your entity files
  logging: true, // logs
  synchronize: true, // sync <Boolean> | turn it off for prod.
});

Note: Always turn off the synchronize for production mode.

Now setup your orm in ./src/server.ts

// import first
import {
  mode,
  port,
  setupTypeOrm  // imported ...
} from './configs';
----------------------------------------------
const initDatabase = async () => {
  /// setup your database in here .....
  await setupTypeOrm
    .initialize()
    .then(() => {
      console.log('Data Source has been initialized!');
    })
    .catch((err) => {
      console.error('Error during Data Source initialization:', err);
    });
};

Let's make an entity class as an example
create a file like ./src/services/user/user.entity.ts

import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  firstName: string;

  @Column()
  lastName: string;
}

For more informations about typeorm: https://typeorm.io/

--- Thanks