Group50_Proj2 - GITS3.1 - Sometimes all you need to do is make a REQUEST!!!!

Setup - YouTube Link
Tutorial - YouTube Link

GITS3.1 - I.R.I.S (Ideal ReposItory for Software projects)

.

About GITS3.1

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

So you want to start a Project on Github

Do CLI commands scare you??

Do platform dependencies of softwares available annoy you??

Don't worry we got you! Introducing GITS3.1

GITS3.1 simplifies the organization of your repository according to Software Engineering Standards, ensuring it adheres to the required structure for a "Well-Structured Repository."

Think of GITS3.1 as a foundational repository that helps align your project repository with these standards.

Here are few motivation points to come up with this idea

1. When dealing with various files and branches, there often arises a need to update multiple commands in a particular sequence, which can become cumbersome. Employing a custom command that can execute multiple commands simultaneously in a predefined order is a time-saving and developer-friendly solution.
2. While tackling an assignment for the course, we discovered a shortage of project repositories that follow a standardized structure.
3. Developers might struggle to create projects that are easily transferable.

Installation Setup

1. Install the pre-requisites Python 3.9 or above from here and Git from here.
2. Open terminal and clone repository git clone https://github.com/psvkaushik/Group50_Proj2
3. Navigate to the directory and enter following command on terminal for linux or mac os bash setup.sh Navigate to the directory and enter following command on terminal for windows windows_setup

IMPORTANT: Generate a token of your account (make sure to allow everything in token) and add the token in line 30 of app.py

Detail about generating token is given here

1. Navigate to the project directory and run the app.py file as follows bash python3 ./src/app.py Quick start guide can be found here\ Case studies can be found here
   Troubleshooting steps can be found here

Documentation

The primary goal of this project is to simplify the tasks of developers as they collaborate on their project repositories. GITS3.1 streamlines their workflow, enhances efficiency, and minimizes time spent by offering essential default files in the proper structure. This approach allows naive users/developers to concentrate on improving their projects without the burden of repository management. Functional code details can be found here

Task list

• [x] Initally , the software had separate implementaion for Linux, Windows or MAC . Now we have made sure the commands can be executed on all platforms without any dependancies
• [x] Also made an executable to setup the project on command line for ease of use for the user
• [x] Implemented a UI
• [x] Provided feature to add custom commands and included instaructions on using template to create corressponding code

Third Party Dependencies

1. Git link
2. Python link
3. Requests link
4. Flask link
5. PyYaml linl

Road-map ahead

• [ ] Containerize the application
• [ ] Website without refresh
• [ ] Custom commands can be added without template
• [ ] Host application on cloud

Contributors

• :octocat: Ayush Agarwal
• :octocat: Kaushik Pillalamarri
• :octocat: Surya Upadyayula
• :octocat: Vaishnavi Naik

Contact us

For any questions and contribution please contact: gits3.1project@gmail.com

Made with ❤️ on GitHub.