Skip to content

Latest commit

 

History

History
125 lines (87 loc) · 5.51 KB

README.md

File metadata and controls

125 lines (87 loc) · 5.51 KB
Raw

GITS2.1 - I.R.I.S

GitHub codecov DOI GitHub issues GitHub closed issues Github pull requests GitHub stars version GitHub contributors GitHub code size in bytes

gits check_conflicts

Functionalities Implemented

We added automatic merge conflict detection using gits check_conflicts. This allows you to preview merge conflicts before they happen. This feature is powered by GitHub CLI. We have provided a Dockerfile which includes GitHub CLI and Python3 so you can build an image using GITS (Docker installation instructions below).

The full demo for gits check_conflicts can be seen here

About

"Your repo is your resume. But what is a good looking repo?"

So you want to start a Project on Github. Ever wondered what makes a project repository good? What makes your project stand apart when collaborating with multiple developers? What would ensure that your project is well documented and readable to other developers who might try to work on this in the future?

bash requirements.sh

Worry not. I.R.I.S is here.

I.R.I.S (Ideal ReposItory for Software projects) is a tool which can help developers align their repos as per the standards defined in Software Engineering.

You don't have to worry about missing a test case, or scratch your head on what more files or functionalities are needed to make your repository look good.

I.R.I.S streamlines your repository as per the Software Engineering Standards, so that your repository has all the necessary Structure to be called a "Good Repo".

I.R.I.S can be thought of a base repo to make sure your project repo fits the bill.

On Linux/MacOS Machines

  1. Clone GITS Repo

  2. From the root directory run the following command

    pip install -r requirements.txt

  3. Go to configurations directory and run the following command:

    If you are working on Linux system with a bash terminal or a Windows system using Windows subsystem for linux:

    bash project_init.sh

    If you are working on Linux system with a fish terminal:

    fish project_init.fish

  4. Source the bashrc file

    source ~/.bashrc

    Note: Open the .bashrc file in User home directory to make sure that the alias command does not have any white spaces in the path. If so, rename the directory to remove the white spaces and re-run the setup.

Installation for Windows

  1. Clone GITS Repo
  2. From the root directory run the following command 
    pip install -r requirements.txt
  3. Run "windows_setup.bat" from configurations folder to setup environment.
  4. Run "autoRun.bat" as administrator.
  5. Now gits command is accessible all over the system.

Installation Using Docker

We have provided a Dockerfile to build an image containing GITS

  1. Clone GITS Repo
  2. Enter repo directory
  3. With Docker installed and the Docker daemon running run the following command 
    docker build -t image_name .
  4. Now run a container with the following command 
    docker run -d -it image_name /bin/bash
  5. Now the container is running with Python3, GitHub CLI and GITS

How to Contribute?

Please take a look at our CONTRIBUTING.md where we provide instructions on contributing to the repo and help us in enhancing the current video conferencing platforms.

Team Members

This repository is made for CSC-510 Software Engineering Course at NC State University for Fall 2023.


Joshua Joseph
Jacob Gerlach

Uchswas Paul
Sana Mahmoud

Contact Us:

For any questions and contribution please contact: [email protected]

Made with ❤️ on GitHub.