Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 1.26 KB

File metadata and controls

65 lines (43 loc) · 1.26 KB

GitHub scanner

A tool to scan GitHub repositories using GraphQL queries

Table of Contents

Getting Started

These instructions will guide you through the process of setting up a local development environment.

Prerequisites

  • Git, Node.js, npm, should be installed
  • A token for access to the GitHub API should be created

Installation

A step-by-step sequence of examples that tell you how to get your development environment running.

  1. Clone the repository to your local machine

    git clone {repo-link}
  2. Navigate to the project directory

    cd {project-directory}
  3. Install pnpm globally if not installed

    npm install -g pnpm
  4. Navigate to the backend folder and copy env.template to .env

    cd backend
    cp env.template .env
  5. Return to the project root

    cd ..
  6. Install the project dependencies using pnpm

    pnpm i

Issues