Blog GraphQL API

This repository contains the GraphQL API for the Blog application.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js
• npm
• Docker (For Docker-based development and testing)

Useful Links

• API Documentation
• Production GraphQL Playground

Getting Started

Installation

1. Install the required packages:

   npm install

   Alternatively, you can use the shorthand:

   npm i

2. Review the .env-example file in the root of the project. Create a .env file in the same location and populate it with your specific environment variables.

3. Start the application:

   npm run start

Testing

Running Tests

1. To execute the tests, run:

   npm run test

Test Coverage

1. To generate a test coverage report, run:

   npm run test:cov

Docker

For local testing and development using Docker:

1. Start the Docker containers:

   docker compose up

Additional Information

All available commands can be found in the scripts section of the package.json file. The .env-example file in the root directory provides a template for environment variables.