Skip to content

Git View is an educational open source project developed by the web development students at ECV Digital.

Notifications You must be signed in to change notification settings

ecvdbdx/git-view

Repository files navigation

Git View

Git View Logo
Git View is an educational open source project developed by the web development students at ECV Digital.
Using VueJs and ElectronJs
VueJs Logo Electronjs Logo

Table of content

  1. Getting Started
  2. Release Guide
  3. Architecture
  4. Contribution Guide

Getting Started

Installation

npm install

Start development server

npm run electron:serve

Build for production

npm run electron:build

Release Guide

⚠️ Every new release published will notify users and update there electron app

Github token

Create a .env file at the root of your local project. Copy the content of .env.example and put your Github token in.

Release process

  1. Update app version in the package.json following the Semantic Versioning guidelines.
  2. Commit and push the app version update on a dedicated branch using this pattern: "release/: {version_number}".
  3. When the branch is ready and merged, run the following command on the main branch: npm run gh-publish.
  4. A pre-release should be created in the github repo and can be release.