/tutorial-graphql-apirocket

Apirocket - The tool used by the world's laziest web developers to create their GraphQL API.

Primary LanguageJavaScriptMIT LicenseMIT




Tutorial GraphQL Apirocket

The tool used by the world's laziest web developers to create their GraphQL API



🔖 Description

For this tutorial you need to create a user account on the platform https://www.apirocket.io/

You can create collections in GraphQL and interact with them in a Dashboard. In this tutorial we have used a collection with the following structure:

📌 Methodologies and Guidelines

Quality Assurance Code (QAC)

✅ Prerequisites

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

  • NodeJS Version: 14.xx
  • NPM Version: 6.14.7

📐 How to work with this project

1️⃣ Add the enviroments files

Create and add .env file into the main folder of this project. You can see the schema of this file here "env/.env.schema", for example:

# -------- CONFIGURATION NODEJS PROJECT ------------------
NODE_ENV=DEV
# --------------------------------------------------------

# -------- CONFIGURATION APIROCKET CONNECTION ------------
APIROCKET_HOSTNAME=graphql.apirocket.io
APIROCKET_API_TOKEN=1234567890
# --------------------------------------------------------

2️⃣ Install NodeJS Dependencies

Install project dependencies.

$npm i

3️⃣ Run Application

Execute the follow sentence for run this application.

$npm run start

📂 Code scaffolding

/
├── assets 🌈               # Images Sources.
├── env 🔌                  # Enviroments.
├── src 💯                  # Main NodeJS Application.
└── ...

⛽️ 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
$ncu

License

MIT

Happy Code

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

This README.md file has been written keeping in mind