Phone-Book-Graphql

A simple API GraphQL for experiencing testing frameworks

Github Actions

Requirements

• MongoDB
• Node & Npm

Install && Run

It follows one step by step showing how to get the API running.

Clone repository

git clone https://github.com/fredmoreira/phone-book-graphql.git

Install

npm i

If you don't have the MongoDB database installed on your local machine, remember to run it via command line or another way before running the command below.

npm start

Runing integration tests

npm test

Lint

npm run code:lint

Code check

npm run code:check

Prettier

npm run code:prettier

Check vulnerabilities in dependencies

npm run snyk-protect

The precommit is done by git hooks by package husky.

Therefore, whenever a commit is done, the following script will be executed:

npm run code:lint && npm run code:prettier

Any improvement will always be welcome. 🚀 😄