search

dartmouth-cs98 / 21f-gitbetter

21f-gitbetter created by GitHub Classroom
0 stars 0 forks source link

readme

GitBetter

Ever felt clueless trying to find which git command is appropriate for your use case? Ever ran through a series of commands to see what would work, only to delete and reclone the entire repository?

GitBetter is a platform where users can hook up their project repository and test various git commands to see the effects that the commands would have on their project's status. Through GitBetter, you will be able to walk through various commands and visualize the effects the command has on your code. In doing so, we hope to alleviate your stress about possibly messing up your project's repository as there will be no permanent repercussions.

To see what the application looks like, check out the project preview section below.

To download Gitbetter, visit our project site.

Architecture

This project was build using Vue 2 and an Electron framework. It uses Xterm.js to run the embedded terminal.

Setup

This project was tested and developed using Node 14. If your code is failing to build or compile locally using a different version of node, we recommend using Node 14.

To run the project locally...

npm install
npm run dev

Deployment

Deploying a production build

npm install
npm run lint
npm run build
npm run electron:build

The build of the app can be found in the .dmg file, or under applications after running the build.

Using the CLI

GitBetter uses a command line interface. If it's your first time, use the set up instructions below.

From within the GitBetter repository, run:

cp gitbetter-commands.sh ~/.gitbetter-commands.sh 
source ~/.gitbetter-commands.sh

First, run gitstarted, then use gitbetter -h or gitbetter -i for tips on how to use the tool, or information about the tool. For developers: If you make changes to the script, you'll need to rerun cp gitbetter-commands.sh ~/.gitbetter-commands.sh and then source ~/.gitbetter-commands.sh.

Note to Windows Users: The source command might not work in your Powershell or regular command prompt terminal. One workaround is to use Git Bash as your terminal. Instructions on how to install Git Bash can be found here

Project Preview

GitBetter

Opening/ Closing GitBetter

Open-Close

Help Page

Help-Page

Tutorials

Tutorials

Terminal & Visualizations

Terminal-Visualizations

Ctrl-Z Functionality

Back-Forth

GitLearning

Guided Tutorials

GitLearning-Tutorials

About Git and Search Commands Pages

Test Yourself

Quiz

The Gitbetter Team

Team Selfie

Acknowledgments

We would like to acknowledge Professor Tregubov and the teaching assistants of CS98 for the guidance and support they've provided us while building our app.