fredmoreira / phone-book-graphql

A simple API GraphQL for experiencing testing frameworks

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. 🚀 😄

phone-book-graphql's Issues

Implement resolvers and mutations

• Delete contact
• Update contact

Refactor .eslintrc.js

I've selected .eslintrc.js:.eslintrc.js for refactoring, which is a unit of 21 lines of code. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Short Units of Code guideline rating! 👍

Here's the gist of this guideline:

• Definition 📖
  Limit the length of code units to 15 lines of code.
• Why❓
  Small units are easier to analyse, test and reuse.
• How 🔧
  When writing new units, don't let them grow above 15 lines of code. When a unit grows beyond this, split it in smaller units of no longer than 15 lines.

You can find more info about this guideline in Building Maintainable Software. 📖

---

ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁

---

Good luck and happy coding! ✨ 💯