Skip to content

YulikK/graphiql-app

Repository files navigation

Rest-GraphQL App

Welcome to the Rest-GraphQL App project! This interactive platform allows users to make both REST and GraphQL requests to user-specified endpoints, with additional features like authorization, authentication, and a history page that saves past requests for easy access.

Technology stack

TypeScript React NextJs React Hook Form Redux MUI firebase Netlify

Team Members

Project Overview

This project aims to create a robust Rest-GraphQL application with the following key features:

  • Efficient RESTful API Requests: Easily perform and manage your RESTful API requests with a user-friendly interface designed for efficiency.

  • Seamless GraphQL Integration: Take advantage of our built-in GraphiQL interface for smooth and intuitive GraphQL queries and mutations.

  • Automatic Query Formatting: Automatically format and organize your queries for improved readability and maintenance.

  • Secure Authentication: Ensure your data is protected with built-in Firebase authentication.

  • Multi-language Support: Choose your preferred language for a personalized experience.

  • Comprehensive Request History: Easily revisit and rerun previous API requests with our robust history feature.

Getting Started

To get a local copy - follow these simple steps.

Installation

  1. Clone the repo
  git clone https://github.com/YulikK/graphiql-app.git
  1. Install NPM packages
  npm install
  1. Ask team to produce the .env.local file with settings and place it in the project root.

  2. Start project

  npm run dev

Provided scripts

npm run dev

Start local development server

npm run build

Build project in production mode for further deployment

npm run format:fix

Reformat source code & configs to match Prettier settings

npm run ci:format

Check source code with Prettier

npm run lint

Check source code with ESLint. Exit with non-zero return code after the first found warning (useful for CI/CD)

npm run lint:fix

Automatically fix all auto-fixable errors & warnings with ESLint

npm run prepare

Runs automatically after package installation to install Husky hooks

npm run test

Runs tests with Vitest

npm run test:coverage

Runs tests with Vitest and displays coverage of implemented tests

Happy coding!