# XForkExplorer

**Repository Path**: open-source-group/XForkExplorer

## Basic Information

- **Project Name**: XForkExplorer
- **Description**: This is the fork summary generation tools - XForkExplorer for developers to get an Overview of GitHub projects.
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-17
- **Last Updated**: 2021-03-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# XForkExplorer 

### Description

This is the fork summary generation tools for developers to get an Overview of GitHub projects.

### Software Architecture

#### XForkExplorer provides an more convenient interface of fork summary which can be optimal for lightweight software. It also provide an visualization web platform which can provide the summary overview. 

#### What's more, we also have another impletement for XForkExplorer based Knowledge Graph, but it's an offline tool which means the users should download the whole GitHub project and do a lot of data processing and finally to get the fork summary.

### Exhibition for XForkExplorer 

![Figure1. The Interface of XForkExplorer.](https://toscode.gitee.com/open-source-group/XForkExplorer/blob/master/Image/XForkExplorer_Interface.png)

![Figure2. The web platform of XForkExplorer.](https://toscode.gitee.com/open-source-group/XForkExplorer/blob/master/Image/XForkExplorer1_Web.png)

![Figure3. The web platform of KG-based XForkExplorer.](https://toscode.gitee.com/open-source-group/XForkExplorer/blob/master/Image/XForkExplorer_Web.png)

### Installation

1.  You should install the requirement pakeages using the following commend:

```
    pip install requirement.txt
```

2.  Then, if you want run the web page, you should npm install the requirement pakeages and start the vue frame:

```
    npm install
    npm run server
```

3.  For the KG-based XForkExplorer, you can see this [KG-based XForkExplorer](https://toscode.gitee.com/open-source-group/kg-based-xfork-explorer)

### Instructions

1.  After installation, you can run **app.py to start the XForkExplorer.

2.  You can use the following commend to call **interface of XForkExplorer**:

```
your_ip/quary?commit_id1=xxxx&commit_id2=xxxx
```
      where commit_id1 is the latest commit id of the aim project and commit_id2 is the former commit id of the aim project

3.  You can visit the web page to get visualization at *localhost:8080

### Features about this project.

1.  Help developers get fork summary.
2.  Provide a interface and web visualization tools of XForkExplorer
3.  Implement this again using Knowledge graph.

### Contribution

1.  Fork this repository.
2.  Create a new branch named "XFS_xxx"
3.  Commit your contributions.
4.  Get a Pull Request.

### Contact us

@rebewu Menghan Wu

@yoakehiyori Yi Huang

### Welcome to contribute this project, thx!!!