node-express-graphql-prisma

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #android #machine-learning #deep-learning #nodejs #java #windows #awesome #cli #awesome-list #vue #pytorch

node-express-graphql-prisma

(★ 13)

Node express Prisma ORM graphql js SDL modulerized - graphql api

node-express-graphql-prisma 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# This is Simple Nodejs Express Starter Kit

#### Node express + Prisma ORM + graphql js SDL modulerized - graphql api

You can use it for your project. If it is useful for you,  
don't forget to give me a **GitHub star**, please.

In this node/express template

- Express framework
- DB - MySQL or PostgreSQL
- Prisma ORM
- graphql api ( graphql.js, graphql-http, graphql-tools)
- JWT auth
- bcrypt
- validator
- error handler
- file uploading
- Authorization
- Pagination ( offset-based & cursor-based ) etc.

In order to use it,

**Create** a .env file and add this.  
For **MySQL**

```
DATABASE_URL="mysql://username:password@localhost:3306/mydb"
TOKEN_SECRET="something hard to guess"

```

For **PostgreSQL**

```
DATABASE_URL="postgresql://username:password@localhost:5432/mydb?schema=public"
TOKEN_SECRET="something hard to guess"

```

Please note.  
_TOKEN_SECRET_ should be complex and hard to guess.

`File Uploading Process`

If you use file uploading feature in this kit,  
create nested folders `uploads/images` in the root directory.  
But making directories is up to you. You can configure in `src/utils/uploadFile.js`.  
My method is to use REST endpoints specifically for file uploads while keeping  
the GraphQL API for other operations. This approach leverages the strengths of  
both REST and GraphQL and can simplify the file upload process.

That's why, first, you should call REST endpoint for file upload.  
It will give a response with image url link. And then, graphql api can be called  
as usual in order to store that link in the database. Done!

For large projects, it is the best solution to use aws S3, DigitalOcean space, etc., instead of using file system.

Warning - every `*.graphql & *.resolver.js` must be inside three nested folders `./**/**/**/file` .  
It's ok `./src/graphql/auth/auth.graphql` or `./src/graphql/product/product.graphql` or something like that.

## Step by Step Installation

```bash
mkdir lucky
cd lucky
git clone https://github.com/Bonekyaw/node-express-graphql-prisma.git .
rm -rf .git
npm install
npm start

```

Before you run, make sure you've created .env file and completed required information.

I'm trying best to provide the **latest** version. But some packages may not be latest after some months. If so, you can upgrade manually one after one, or you can upgrade all at once.

```bash
npm install -g npm-check-updates
npm outdated
ncu --upgrade
npm install
```

If you find some codes not working well, please let me know your problems.

For Graphql Query, use Postman.  
You will see everything about graphql queries. Thanks, Postman.

```graphql
mutation Register {
  register(phone: "0977*******7") {
    message
    phone
    token
  }
}

mutation VerifyOtp {
  verifyOtp(
    userInput: {
      token: "3llh4zb6rkygbrah5demt7"
      phone: "77******7"
      otp: "123456"
    }
  ) {
    message
    phone
    token
  }
}

mutation ConfirmPassword {
  confirmPassword(
    token: "xdyj8leue6ndwqoxc9lzaxl16enm0gkn"
    userInput: { phone: "77*******7", password: "12345678" }
  ) {
    message
    token
    phone
    userId
    randomToken
  }
}

mutation Login {
  login(userInput: { phone: "0977******7", password: "12345678" }) {
    message
    token
    phone
    userId
    randomToken
  }
}

mutation RefreshToken {
  refreshToken(
    userInput: { userId: "1", randomToken: "b6x9na0z5abc7wix1t2ojj5hdkk7aosm6" }
  ) {
    message
    token
    userId
    randomToken
  }
}

mutation UploadProfile {
  uploadProfile(userInput: { imageUrl: "uploads/images/abc.png" }) {
    message
    imageUrl
  }
}

query PaginateAdmins {
  paginateAdmins(page: 1, limit: 10) {
    total
    data {
      id
      name
      phone
      role
      status
      lastLogin
      profile
      createdAt
    }
    pageInfo {
      currentPage
      previousPage
      nextPage
      lastPage
      countPerPage
      nextCursor
      hasNextPage
    }
  }
}
```

### How to develop your own products using this Starter Kits

When you add other route files to build some **REST api** including file uploading, you can also create `src/routes/v1/api` `src/routes/v1/web` folders and use prefix for route defination. for example,

```javascript
const adminRoutes = require("./routes/v1/web/admin");
...
app.use("/v1/admins", isAuth, authorise(true, "admin"), adminRoutes);
```

Hey, you see the words: `isAuth` & `authorise` ?  
Yeah, these are custom middlewares. You can create and use them by yourself. I will show how to use my sample authorization middleware.

Authorization as a middleware

```javascript
const authorise = require('./middlewares/authorise');
...
app.use("/api/v1", isAuth, authorise(true, "admin"), adminRoutes);

router.get('/admins', authorise(true, "admin"), adminController.index);
```

Authorization as a function

```javascript
const authorise = require("./../utils/authorise");
...
authorise(true, user, "admin");
```

`true, "admin"` means the account is allowed only if its role is "admin". `false, "user"` means the account is not allowed if its role is "user".  
`ture, "admin"` === `false, "user", "supplier"`  
`false, "user"` === `true, "admin", "supplier"`

`true, user, "admin"` In these parameters, user param is an instance model of the database table.

In this graphql starter kit,  
I built authentication & authorization with the help of composeResolvers tool.

```javascript
const isAuthenticated = () => (next) => (parent, args, context, info) => {
  checkAdminExist(context.authHeader);
  let token = context.authHeader.split(" ")[1]; // Hey take care!
  if (validator.isEmpty(token.trim()) || !validator.isJWT(token)) {
    throw new GraphQLError("Token must not be invalid.", {
      extensions: {
        code: "BAD REQUEST",
        http: { status: 400 },
      },
    });
  }
  token = validator.escape(token);
  const adminId = isAuth(token);
  info.adminId = adminId;

return next(parent, args, context, info);
};

const hasRole =
  (...role) =>
  (next) =>
    asyncHandler(async (root, args, context, info) => {
      let adminId = info.adminId;
      const admin = await Admin.findById(adminId);
      checkAdminExist(admin);
      authorise(false, admin, ...role);
      info.admin = admin;

return next(root, args, context, info);
    });

const resolversComposition = {
  "Mutation.uploadProfile": [isAuthenticated(), hasRole("user")],
  "Query.paginateAdmins": [isAuthenticated(), hasRole("user")],
};

const composedResolvers = composeResolvers(resolvers, resolversComposition);
module.exports = composedResolvers;
```

### Pagination

There are two ways in pagination: **offset-based** and **cursor-based**. You can read more about pros and cons [here](https://www.prisma.io/docs/orm/prisma-client/queries/pagination). But you can use my pagination logic very easily.

For offset-based

```javascript
const { offset, noCount, cursor } = require("./../utils/paginate");
...
let { page, cursors, limit } = args;

const filters = { status: "active" };
const order = { id: "desc" };

return offset(prisma.admin, page, limit, filters, order);
```

For cursor-based

```javascript
const { offset, noCount, cursor } = require("./../utils/paginate");
...
let { page, cursors, limit } = args;

const filters = { status: "active" };
const order = { id: "desc" };

return cursor(prisma.admin, cursors, limit, filters, order);

```

I promise new features will come in the future if I have much time.

If you have something hard to solve,
DM  
<phonenai2014@gmail.com>  
<https://www.facebook.com/phonenyo1986/>  
<https://www.linkedin.com/in/phone-nyo-704596135>

#### Find more other Starter kits of mine ?

`Nest JS for REST Api`

[Nest JS + Prisma ORM - REST api](https://github.com/Bonekyaw/nest-prisma-sql-rest)

`Nest JS for Graphql Api`

[Nest JS + Prisma ORM - Graphql api](https://github.com/Bonekyaw/nest-prisma-graphql)

`Node Express JS For REST Api`

[Express + Prisma ORM + mongodb - rest api](https://github.com/Bonekyaw/node-express-prisma-mongodb)  
 [Express + Prisma ORM + SQL - rest api](https://github.com/Bonekyaw/node-express-prisma-rest)  
 [Express + mongodb - rest api](https://github.com/Bonekyaw/node-express-mongodb-rest)  
 [Express + mongoose ODM - rest api](https://github.com/Bonekyaw/node-express-nosql-rest)  
 [Express + sequelize ORM - rest api](https://github.com/Bonekyaw/node-express-sql-rest)

`Node Express JS For Graphql Api`

[Apollo server + Prisma ORM + SDL modulerized - graphql api](https://github.com/Bonekyaw/apollo-graphql-prisma)  
 [Express + Prisma ORM + graphql js SDL modulerized - graphql api](https://github.com/Bonekyaw/node-express-graphql-prisma) - Now you are here  
 [Express + Apollo server + mongoose - graphql api](https://github.com/Bonekyaw/node-express-apollo-nosql)  
 [Express + graphql js + mongoose - graphql api](https://github.com/Bonekyaw/node-express-nosql-graphql)  
 [Express + graphql js + sequelize ORM - graphql api](https://github.com/Bonekyaw/node-express-sql-graphql)

`Mobile App Development`

[React Native Expo](https://github.com/Bonekyaw/react-native-expo)

node-express-graphql-prisma

node-express-graphql-prisma 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

node-express-graphql-prisma

node-express-graphql-prisma 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README