mcnaveen / node-express-prisma-boilerplate Goto Github PK

🦄 Starter template for your Express Prisma MySQL API

• Node.js
• Express
• TypeScript
• Prisma
• MySQL

• Clone the repository

git clone https://github.com/mcnaveen/node-express-prisma-boilerplate nepb

• Cd into the project directory

cd nepb

• Install dependencies

yarn install

• Create a Database in MySQL (or) You can use GUI to create a database

mysql> CREATE DATABASE express;

• Copy the .env.sample file as .env

cp .env.sample .env

• Edit the MySQL Details in the .env file

DATABASE_URL="mysql://USERNAME:PASSWORD@localhost:3306/DBNAME?schema=public"

• Push the Prisma Schema into Database

npx prisma migrate dev

• Run the development server

yarn dev

• Run the production build

yarn build

• Start the production server

yarn start

Your production build is available on dist folder

• POST - For Creating New User
• GET - For Getting All Users
• GET - For Getting User By ID
• PATCH - For Updating User By ID
• DELETE - For Deleting User By ID

💡 Please install the Recommended VS Code Extensions and Check api.rest file for Examples

• Creating a New User

POST http://localhost:4000/users
Content-Type: application/json

{
  "name": "john",
  "email": "[email protected]"
}

• Getting All Users

GET http://localhost:4000/users

• Getting User By ID

GET http://localhost:4000/users/1

• Patching User By ID

PATCH http://localhost:4000/users/1
Content-Type: application/json

{
  "name": "newjohn",
  "email": "[email protected]"
}

• Deleting User By ID

DELETE http://localhost:4000/users/1

• MIT