lakeFS Issues

Overview

lakeFS Issues is a React-based web application that allows users to browse and view issues from the lakeFS GitHub repository. It provides a paginated list of issues with expandable details for each issue.

Features

• Fetches and displays GitHub issues for the lakeFS project.
• Pagination support for navigating through issues.
• Expandable issue items to view full issue details.
• Caching mechanism to reduce API calls and improve performance.

Installation and Setup

1. Clone the repository:

   git clone https://github.com/MussiM/lakefs-issues.git
   cd lakefs-issues
   

2. Install dependencies:

   npm install
   

3. Create a .env file in the project root:

   REACT_APP_GITHUB_OWNER='treeverse'
   REACT_APP_GITHUB_REPO='lakeFS'
   REACT_APP_STATE_ISSUES='open'
   REACT_APP_ISSUES_PER_PAGE=10
   REACT_APP_CACHE_DURATION_MINUTES=5
   

Running the Application

Development Mode

To run the application in development mode:

npm start

The application will be available at http://localhost:3000.

Production Build

To create a production build:

npm run build

The built files will be in the build directory.

Using Docker

To build and run the application using Docker:

1. Build the Docker image:

   docker build -t lakefs-issues:1.0.0 .
   

2. Run the container:

   docker run -p 8080:80 lakefs-issues:1.0.0
   

The application will be available at http://localhost:8080.

Configuration

You can modify the following constants in .env:

• owner: The GitHub repository owner.
• repo: The GitHub repository name.
• issuesPerPage: Number of issues to display per page.
• stateIssues: The state of issues to fetch ('open', 'closed', or 'all').
• cacheDuration: The duration for storing data in the cache (in minutes).