Skip to content

This is a boilerplate for API creation using express and prisma 🧩

License

Notifications You must be signed in to change notification settings

werlleyg/boilerplate-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Boilerplate Api


Welcome! 💻✨
This is a boilerplate for API creation using express and prisma 🧩


🛠 Technologies

The tools below were used in the project's development:

âš™ Installation

    1. Install Prisma VS Code Extension (Recommended)
    1. Clone and set up this repository Boilerplate Api
    1. Run npm i or yarn in the project folder on your computer
    1. Add .env data (e.g.: postgresql settings)
    1. Run docker build -t boilerplate-api-image .
    1. Run docker compose up -d data (e.g.: with postgresql image in Docker )
    1. Run npx prisma migrate dev and create first migration (e.g.: create users table)
    1. Run npm run dev or yarn dev
    1. Your project is already running 🔭

📦 Folder architecture and structure

├───.vscode
├───prisma
└───src
    ├───@types
    ├───controllers
    ├───dtos
    ├───errors
    ├───lib
    ├───middlewares
    ├───routes
    └───utils

Developed by Werlley Ponte inspired by Willian Praciano classes