bezany / projects-overview

Simple dashboard for git projects overview

projects-overview

Show simple dashboard with git projects overview.

For each projects from parent folder (excludes this project) shows:

• name (folder name)
• git remotes urls
• publish path from deploy.reloaded plugin for VSCode (very specific case)
• documentations (copy from folder ['docs', 'doc', 'documentation'] if exists)
• README.md

Prerequisites

Need node version 10 for fs Promises API

Quick start

## in projects folder
git clone https://github.com/bezany/projects-overview.git
cd projects-overview
npm install
npm run dev_all

Build Setup

# install dependencies
npm install

# collect projects data
npm run overview

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

For a detailed explanation on how things work, check out the guide and docs for vue-loader.

Collect data

For collect data about projects used sub-project src_collector.

You can filter project by git remotes urls. For this use argument filter-git-remotes (alias f).

Example

cd src_collector
npm run run -- --f="github"
cd ..
npm run dev

Built With

• vue - The Progressive JavaScript Framework
• Vuetify.js - Vue.js Material Component Framework
• git-js - A light weight interface for running git commands.
• vue-markdown - Markdown Parser for Vue
• vue-async-computed - Async computed properties for Vue.js