Skip to content

FEAT: Add GitHub Actions and Docker Configuration #30

@Fidelisaboke

Description

@Fidelisaboke

Short Summary

The GitHub Actions will perform automated tests and other CI/CD tasks. The Dockerfiles will also allow for replication of the project environment on different machines.

Motivation & Context

It is important to ensure that crucial features are working, before attempting to add any new features in future.

Proposed Solution

  • Configure CI/CD Workflow (with formatting and linting checks for frontend and backend)
  • Create pre-commit configuration for local testing before push
  • Create Dockerfile for frontend and backend
  • Run tests locally to ensure CI will pass
  • Update README and SETUP to include CI/CD information

Affected Components

  • Frontend (UI)
  • Backend (API)
  • Ingestion Pipeline
  • RAG Pipeline
  • Vector Storage
  • Documentation
  • Other

Estimated Time (hours)

2

Acceptance Criteria

  • Test succeed both locally and on GitHub
  • Docker containers run without fail
  • Frontend and backend can both be accessed and function properly

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions