https://github.com/willemjiang/insight
This repo provides tools to show the data of ASF projects
https://github.com/willemjiang/insight
data-visualization typescript vue
Last synced: 8 months ago
JSON representation
This repo provides tools to show the data of ASF projects
- Host: GitHub
- URL: https://github.com/willemjiang/insight
- Owner: WillemJiang
- License: apache-2.0
- Created: 2022-09-14T06:04:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T00:31:02.000Z (about 1 year ago)
- Last Synced: 2025-04-15T04:17:28.826Z (10 months ago)
- Topics: data-visualization, typescript, vue
- Language: Vue
- Homepage: https://WillemJiang.github.io/Insight
- Size: 7.1 MB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/WillemJiang/Insight/actions/workflows/build.yml)
# Insight
This repo provides tools to show the project states of ASF.
## How does it work
* ASF publish the projects and committees information [here](https://whimsy.apache.org/public/).
* We can also access the ASF repo development status from Github repo and `https://oss.x-lab.info/repo_detail/apache/${PROJEDT_REPO_NAME}.json`.
Then we can process these data for better data visualization with Apache echarts.
## Preparations for project start-up
1. [Install Python3](https://realpython.com/installing-python/)
2. Install the required library
```
pip install -r script/requirements.txt
```
4. Please run the below command in the root of repo to prepare the data for the frontend to render.
* Running spider.py to grab the Github related data
```
python script/stats.py
```
* Running the stats.py to collect the commitee information from github
```
python script/stats.py
```
5. [Install Node](https://nodejs.dev/en/learn/how-to-install-nodejs/)
## Frontend Data visialization
### Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
### Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
### Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```