Feedback

.gitignore

@@ -163,7 +163,11 @@ cython_debug/
 __pycache__
 config.ini
 app.log
-userdata.json
 videos
+userdata.json
 img
-out
+out
+.vscode/settings.json
+run.bat
+app/temp.png
+.DS_Store

CODE_OF_CONDUCT.md

@@ -0,0 +1,109 @@
+# Code of Conduct
+
+## v1 - Drafted by Izaac Saleh & Sukhwan Ko
+
+## Our Pledge
+
+---
+
+As Members of this developer community, as both leaders and contributors, we pledge to
+respect all people who contribute through reporting issues, posting feature requests,updating documentation,
+submitting pull requests, and other activities.
+
+We aim to make participation a harassment free experience. Discrimination towards, but not limited to: age, body size,
+visible or invisible disability, ethnicity, gender identity and expression, level of
+experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and
+orientation will not be tolerated.
+
+We will act and interact only in ways that promote welcoming, diverse, inclusive and healthy community interactions.
+
+## Our Standards
+
+---
+
+Examples of unacceptable behaviour by participants include but are not limited to:
+
+- Derogatory comments towards others contributions
+- Personal attacks
+- Public or private harassment
+- Publishing others private information such as electronic or physical addresses.
+- Any other conduct that could be reasonably considered inappropriate in a professional setting.
+- Discrimination with regard to _any_ of the criteria mentioned in our **Pledge**
+
+Examples of positive behaviour that contributes to the community:
+
+- Willingness to help others and answer questions
+- Respecting differing opinions and viewpoints that are born of varying experiences.
+- The handling of constructive feedback in a graceful manner be it giving or receiving.
+- Accepting responsibility and accountability for our mistakes, especially when they affect others work and learning
+- from the experience.
+- A focus on the betterment of the community over the individual needs.
+
+## Maintainer Responsibilities
+
+---
+
+Our Community Leaders are responsible for clarifying and enforcing the standards of
+acceptable behviour and are expected to lead by example. If a breach of the Code of Conduct is found to have occured the
+Community Leaders are charged with taking appropriate but fair corrective action.
+
+Community Leaders have the responsibility, and maintain the right, to remove, edit, or reject comments, commits, code,
+issues, and other contributions that are not in alignment with this Code of Conduct and will communicate the reasons for
+any moderations they deem appropriate.
+
+## Scope
+
+---
+
+- Our online platform (website, forum, chatroom etc.)
+- Code repository (including comments, pull requests, issue reports etc.)
+- Project-related communication channels such as:
+  - Email
+  - Slack
+  - Microsoft Teams
+  - Discord
+  - Asana
+  - etc.
+- In-person events(Conferences, meetups etc.)
+
+
+## Enforcement
+
+---
+
+Community leaders will take action to address violations of the Code of Conduct. The specific consequences will depend on the severity of the violation.
+
+
+## Enforcement Guidelines
+
+---
+
+1. Correction
+
+- **Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+- **Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+2. Warning
+
+- **Community Impact:** A violation through a single incident or series of actions.
+
+- **Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+3. Temporary Ban
+
+- **Community Impact:** A serious violation of community standards, including sustained inappropriate behavior.
+
+- **Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+4. Permanent Ban
+
+- **Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+- **Consequence:** A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the GITHUB documents template for "code of conduct" found when adding a file of the
+name to your repo. For steps on accessing this template please see the link below.
+https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# CONTRIBUTING
+
+## v1 - Drafted by Tadiwanashe Gukwa & Lucas Fadersen
+
+Participation in the agile development of this project, including modification, testing, and editing, is only accessible to NM-TAFE students who have received a link to this repository via their outlook email.
+
+## ENFORCEMENT GUIDELINES
+
+---
+
+The is Zero tolerance to plagiarism, make sure that the code you contribute is your own work.
+N.B While working on this project the NM-TAFE code of conduct still applies.
+
+## CONTRIBUTION
+
+---
+
+### Project set up
+
+1. Fork the repo to your local device
+2. Follow the steps on this link to set up the project \***\*link\*\***
+
+## ISSUES
+
+---
+
+1. Identify a Bug: When you Identify a bug during the debugging process, and you intend to fix it you create an issue on GitHub.
+2. Add a description and comment: Make sure that the description of the issue is clear with the issue number and add a comment describing the issue. The issue is reserved for the maker unless open-to-all tag is added.
+3. Add a tag/label to the issue for example bug, enhancement, help wanted, priority: high, priority: low
+4. Add the ready-for-work tag to an open issue when prepared to start working on it. This lets other programmers know that someone is working on the issue in their local IDE. By doing so, collisions are avoided.
+5. Create a Branch: Before you start fixing the issue in your local IDE open your terminal, create a new branch using this command git check out -b <issue number>.
+6. Fix the issue - create a test. When your test passes push the changes
+7. Create a pull request: Create a pull request and associate it with the issue number on the pull request description for example if the issue is issue # 1 the pull request description will include Fixes #1 in the description so that when you merge changes the issue closes automatically.
+8. Code Review - The project maintainers will review the code. Once approved changes will be merged into the main branch
+9. Closing Issue - The issue is closed automatically by GitHub if step 3 was followed correctly
+
+## CODE ENHANCEMENT
+
+---
+
+New ideas can be suggested and discussed on our the Team Discussion Board or Teams Chats first before implementing changes. **_channel link_**
+
+## LICENCE
+
+---
+
+This project is licensed under the [Creative Commons Zero v1.0 Universal](LICENSE) license.
+
+## CODING STYLE
+
+---
+
+Before contributing check this link for the style guide for this project which includes Code lay-out, Comments, Docstrings and naming conversions
+
+- Project STYLE_GUIDE.md (\***\*link\*\***)
+- PEP 8 – Style Guide for Python Code | peps.python.org

Contribution-Guide.md

@@ -0,0 +1,86 @@
+# Contributor's Guide
+
+Welcome to our project! We appreciate your interest in contributing. Below is a comprehensive guide to help you navigate the contribution process smoothly.
+
+## 1. Fork the Main Repository to Your Personal Account: 
+- If you have already forked the repository, you can skip this step. Forking creates a personal copy where you can make changes without affecting the original codebase.
+
+## 2. Keep Your Fork Synchronized with the Main Repository:
+- Regularly sync your forked with the main repository to avoid conflicts. This ensures that your pull request is based on the latest code.
+
+## 3. Clone or Pull Updates to Your Local Machine:
+- Clone your fork onto your local machine to work on the project.
+-    If you don't have a local copy:
+
+```bash
+git clone https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-awesome.git
+
+```
+-   If you have a local copy, pull the latest updates:
+
+```bash
+git pull
+
+```
+
+## 4. Create a New Branch for Your Task:
+- Create a branch for your feature or fix, naming it appropriately.
+
+```bash
+git branch feature/my-feature
+
+```
+- Then switch to the new branch you created
+
+```bash
+git switch feature/my-feature
+
+```
+
+## 5. Write Your Code:
+- Contribute by writing a clean, efficient, and well-documented code.
+- If implementing a new feature, create unit test for your functions.
+
+## 6. Commit Your Work Locally with Descriptive Messages:
+- Commit changes with meaningful messages summarizing your work. Reference the related issue in your commit messages.
+- First stage all your changed files for commit
+
+```bash
+git add .
+```
+
+-Then commit staged files to your local branch
+
+```bash
+git commit -m "feature: implemented my new feature. solves #123"
+```
+
+## 7. Push your Changes to Your Fork:
+- Push your changes to your fork on GitHub for review.
+
+```bash
+git push -u origin feature/my-feature
+
+```
+## 8. Create a Pull Request (PR) to the Main Repository:
+- Submit a pull request to the main repository. This is your formal contribution request.
+
+## 9. Await Review and Address Feedback:
+- Project maintainers will review your PR. Please be patient and address any requested changes promptly.
+
+## 10. Testing and Clean-Up:
+- After PR approval, test changes in the main repository.
+- Clean up branches that are merged and no longer needed.
+
+```bash
+git branch -d feature/my-feature
+
+```
+**Note:** Manually update configuration variables in your [configuration variables](./installation.md)  file if necessary.
+
+By adhering to these contribution guidelines, you contribute to a seamless process for everyone involved in the project! Thank you for your valuable input.
+
+
+
+
+

Home.md

@@ -0,0 +1,19 @@
+# Welcome to the OcrRoo Wiki!
+
+Welcome to the OcrRoo wiki. I have created this wiki to serve as a knowledge base for our project. If you have any suggestions or information you would like added to this wiki don't hesitate to let me know.
+
+### New Features, Bugs, Issues, and Enhancements
+
+If you have found any issues or bugs in the code or you have feature ideas, please create an [issue](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-awesome/issues) on this project. Label it appropriately with feature, bug, enhancement, etc.. You can leave it unassigned if you do not wish to close the issue, however please note if issues are left unassigned for too long they will be assigned to a developer.
+
+### Installing the Project
+
+Please follow the [Installation Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/Installation-Guide) to install and run this project.
+
+### Contributing to the Project
+
+Please follow the [Contribution Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/Contribution-Guide) when contributing to this project.
+
+### Style Guide
+
+Please adhere to the [Style Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/Style-Guide) when contributing to this project.

Installation-Guide.md

@@ -0,0 +1,86 @@
+# Project Installation Guide
+
+This guide provides detailed steps and installing the project on your local machine.
+
+## 1. Clone Project Repository
+
+Clone the main repository to your local machine.If you intend to contribute to the development, clone from your fork of the repository.
+
+```bash
+
+git clone  https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-awesome.git
+
+```
+
+## 2. Navigate to Project Directory 
+
+Change into the project directory.
+
+```bash
+
+cd dip-programming-prj-advanced-gui-awesome.git
+
+```
+
+## 3. Install Dependencies
+
+Install the project dependencies using the following command.
+
+```bash
+
+pip install -r requirements.txt
+
+```
+
+## 4. Navigate to App Directory
+
+Change into app directory.
+
+```bash
+cd app/
+
+```
+
+## 5. (Optional) Configure Application
+
+Copy the `config.example.ini` file and add your relevant configuration variables.Unlike previous versions of OcrRoo, you no longer need to manually create the `config.ini` file;it will generate itself if not present when the server runs.
+
+Using `copy`:
+
+```bash
+copy config.example.ini config.ini
+
+```
+
+Or using `cp`:
+
+```bash
+cp config.example.ini config.ini
+
+```
+
+## 6. Run the Application
+
+To run the application with silenced debug/logging output, execute the following command. Debug and logging outputs will be saved to an `app.log` file
+
+```bash
+python app.py
+
+```
+
+To run the application with debug/logging output in the console, use the following command.This is recommended for development as it automatically reloads the app when changes are detected.
+
+```bash
+flask run --debug
+
+```
+
+## Configuration Variables
+
+To use the project, add the following configuration variables to your `config.ini` file:
+
+- `openai_api_key`: API key for OpenAI
+- `tesseract_executable`: Path to Tesseract OCR executable
+- `ide_executable`: Path to preferred IDE executable
+
+In the current version of the project, this manual configuration is necessary.However, future builds will allow you to perform this configuration from the user interface (UI).