Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.65 KB

README.md

File metadata and controls

55 lines (33 loc) · 1.65 KB

API BOILER PLATE:

Stack:

  • Typescript
  • NodeJs
  • Express
  • Prisma

DOCUMENTATION:

Dev Build:

With database config:

If you want to use the database with Prisma, If you want to use the database with Prisma, you will first have to decide what type of database you want to use (mysql, postgresql, mongodb, etc...)

To do this, you will first need to configure your database, (In the case of a "mysql" database):

  1. Go to the ./prisma/schema.prisma file, and configure your database as follows:

     datasource db {
         provider = "mysql"
         url = env("DATABASE_URL")
     }
    
  2. Create an ".env" file then add an environment variable "DATABASE_URL" with the value of your database uri as follows:

     DATABASE_URL=<PROTOCOL>://<ID>:<PASSWORD>@localhost:3306/<DATABASE_NAME>
    
  3. Design your database schema on the ./prisma/schema.prisma

  4. You can seed your database from a ./prisma/seed.ts file


Then run:

pnpm build:dev:db || npm run build:dev:db

You can take a look at the prisma documentation here -> Prisma Documentation

Without database config:

Run:

pnpm build:dev || npm run build:dev

Connection persistence:

The boilerplate uses express-session middleware (session cookie) with mysql, for client-side connection persistence.
It does not use jwt, because security level I do not recommend it.
I advise you to read this article, which explains in a very charming way the reason -> Stop using JWT for sessions