neverovski / repository-scanner

Installation

Development environment requirements:

• Docker >= 17.06
• Docker Compose
• Node.js >= 20

Project initialization

1. Setup Environment Variables:

  cp .env.example .env

2. Run Services with Docker Compose:

  docker compose up -d --build

3. Run Services without Docker:

  npm run start

Accessing the Application

The application is running a GraphQL endpoint that is accessible via the following URL:

http://127.0.0.1:5656/graphql

Click the link to open it in your browser, or you can use your preferred HTTP client to start making requests.

Notes

1. Enable Git hooks

  npx husky init

2. Why is my git pre-commit hook not executable by default?

• Because files are not executable by default; they must be set to be executable.

  chmod ug+x .husky/*
  chmod ug+x .git/hooks/*

3. Project Structure

Name	Description
src/	Main source code directory
src/common/	Shared code across different parts of the application
src/config/	Configuration files
src/core/	Core logic or main parts of the application
src/modules/	Self-contained parts of the application
src/providers/	Service provider code (data fetching, helper functions)
src/utils/	Common utility functions
tests/	Test cases
tests/unit/	Unit tests for individual code units
tests/integration/	Integration tests checking if different parts work together