Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 3.19 KB

README.md

File metadata and controls

67 lines (40 loc) · 3.19 KB
Raw

Commitizen friendly

Please note that this is Work In Progress. Feel free to open issues, contribute or give feedback.

Requirements:

  • Docker
  • Docker Compose
  • Prisma CLI version 1 (npm install -g prisma1)
  • Node version 16 and NPM version 8

Quick start

  1. Install dependencies: npm install
  2. Launch the Postgres database and Prisma server: docker-compose up -d
  3. Deploy your models to Prisma and generate the client: cd src/prisma && prisma generate && prisma deploy
  4. Run the API for development: npm run dev
  5. Access the playground of your Graphql API at http://localhost:4000

Features

  • Prisma as an ORM
  • GraphQL Modules
  • Authentication: using GraphQL Shield or as a GraphQL module

GraphQL Modules

The backend is organized into GraphQL modules.

More information in this Medium post

Each module merges its types and resolvers in order to export a GraphQLModule instance. These modules are then imported and merged into a single GraphQLModule module in the file src/api/modules/index.js. This object holds, among others, the schema and context which are fed to the ApolloServer instance in src/api/index.js

GraphQL modules offers extensibility of your code base and forces/helps you organize your SDL types by domain/feature rather than by type.

Prisma

Make sure the environment variable DATABASE_URL is well defined in .env, then generate and apply migrations on the database: npx prisma migrate dev --name init.

Generate Prisma client from the Schema: npx prisma generate. The Prisma client will be available as an NPM package under node_modules/@prisma/client.

To seed the database, run npx prisma db seed. If you have the environment variable NODE_ENV set to development, it will fill the database with test data.

Branches

This project contains two more branches with additional features compared to the backend:

  • graphql-shield: authentication implemented using the GraphQL shield package
  • nuxt-frontend: minimal frontend built using Nuxt with Auth0 authentication configured. Its purpose is to give a working example of the front side of authentication

Contributing

In order to keep the graphql-shield and nuxt-frontend branches in sync with the master branch, all modifications related to the backend must be implemented first in the master branch then merged into the branch in question. Only then can additional modifications of the backend, specific to that branch, be added.

Please use the alias npm run commit for Commitizen friendly commits.

Todos and roadmap

NodeJS best practices checklist:

  • 1.5 Use environment aware, secure and hierarchical config

Using the [node-config] package with Webpack. See

  • Clean datasources
  • Documentation and references
  • GrahQL CLI scaffolding support