Tutorial Fastify with GraphQL and PouchDB

🔖 Description

Tutorial and Examples of how to work with Fastify, GraphQL and PouchDB. Working via REST API and GraphQL API with Postman and GraphiQL.

📹 Video Demo

The following videos shows how you can work with this project and execute request to the REST API from Postman and to the GraphQL API from Postman and from GraphiQL.

• Run NPM Install and create seed for the first Start.
  

• How work with Rest API via Postman
  

• How work with GraphQL API via Postman
  

• How work with GraphQL API via GraphiQL
  

📌 Methodologies and Guidelines

List of methodologies and tools used in this project for compliance with Quality Assurance Code (QAC)

• TypeScript, These projects provide templates which include TypeScript support.
  NPM TypeScript
• ESTlint, tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
  NPM ESLint
  NPM ESLint | Airbnb
• Jest, delightful JavaScript Testing.
  NPM Jest
• SuperTest, HTTP assertions made easy via superagent.
  NPM SuperTest
• Mozilla, Standard HTTP response status codes.
  HTTP Status MOZILLA

⚡️ Technologies and Tools

The project structure has been created with Yeoman and Generator Standard REST API Projects.

• Yeoman
• Yeoman | Generator Standard REST API Projects

The main libraries and tools used in this project are:

• Fastify
• GraphQL
• PouchDB

✅ Prerequisites

In order to work with this project, your local environment must have at least the following versions:

• NodeJS Version: 12.xx
• NPM Version: 6.12.0

🌀 Workflow HTTP REST API

With these two graphs I want to expose the life cycle when we use the endpoints with GraphQL and without it.

Fastify and PouchDB

Fastify, GraphQL and PouchDB

📐 How to work with this project

You have to do the following steps to be able to work with this project.

1️⃣ Install NodeJS Dependencies

To work with this project locally and to be able to deploy in different environments, it is necessary to install the NPM dependencies.

# Install npm dependencies
$npm i

2️⃣ Development

To add the seed for /articles endpoints you will have to execute the following command:

# Seed
$npm run create:seed

To run the project locally and to develop you will have to execute the following command (You will see a message on your terminal with the address and port of the local server):

# Run
$npm run start:watch

To run the unit tests of this project you will have to execute the following command:

# Tests
$npm run test

🔌 Enviroments files

If you have selected one or more environments you will see an env file for each environment that you can modify. The complete list of the .env files that you should have in the "env" folder should be:

• .env.local

📂 Code scaffolding

/
├── assets 🌈               # Images Sources.
├── doc
|   ├── api 🚠              # Api Versions.
|   ├── qac 🔰              # Quality Assurance Code.
├── env 🔌                  # Configure enviroments deploy.
├── src
|   ├── __mocks__ 👻        # Mocks data for test.
|   ├── __tests__ 🚥        # Unit tests.
|   ├── config              # Generic config.
|   ├── controllers         # Controllers.
|   ├── libs                # Custom libreries and tools.
|   ├── resolvers           # GraphQL Resolvers.
|   ├── routes              # Routes.
|   ├── services            # Services.
|   ├── shemas              # GraphQL Shemas.
|   ├── types               # TypeScript types.
|   └── ...
└── ...

📦 Core and Libraries

This project is based on the Fastify framework as a core for the development of the project structure and with custom libraries.

🚠 API Documentation

Version	DOC	Postman
REST	More Info	Collection
GraphQL	More Info	Collection

🔮 GraphiQL

GraphiQL is the reference implementation of this monorepo, GraphQL IDE, an official project under the GraphQL Foundation.

You can to work with the GraphiQL IDE in your browser.

• GraphiQL Info and Examples

⛽️ Review and Update Dependences

For review and update all npm dependences of this project you need install in global npm package "npm-check-updates" npm module.

# Install and Run
$npm i -g npm-check-updates

# Run library to check npm modules
$ncu

Happy Code

Created with JavaScript, lot of ❤️ and a few ☕️

This README.md file has been written keeping in mind

• GitHub Markdown
• Emoji Cheat Sheet