Skip to content

Commit

Permalink
Merge pull request #554 from COS301-SE-2023/test
Browse files Browse the repository at this point in the history 
Test -> main readme updates
  • Loading branch information
@JanSpies82
JanSpies82 authored Oct 24, 2023
2 parents 1045e46 + ca6da01 commit 8ac2f3e
Showing 1 changed file with 45 additions and 75 deletions.
120 changes: 45 additions & 75 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,43 @@
<img alt="Angular" src="https://img.shields.io/badge/angular-dd0031?style=for-the-badge&logo=angular&logoColor=white" />
</a>

<a href="https://primeng.org/">
<img alt="Angular" src="https://img.shields.io/badge/primeng-dd0031?style=for-the-badge&logo=primeng&logoColor=white" />
</a>

<a href="https://nestjs.com/">
<img alt="NestJS" src="https://img.shields.io/badge/nestjs-e0234e?style=for-the-badge&logo=nestjs&logoColor=white" />
</a>

<a href="https://aws.amazon.com/ec2/">
<img alt="AWS EC2" src="https://img.shields.io/badge/amazon%20ec2-dd700f?style=for-the-badge&logo=aws&logoColor=white" />
</a>

<a href="https://mariadb.org/">
<img alt="MARIADB" src="https://img.shields.io/badge/mariadb-142958?style=for-the-badge&logo=mariadb&logoColor=white" />
</a>

<a href="https://nestjs.com/">
<img alt="NestJS" src="https://img.shields.io/badge/nestjs-e0234e?style=for-the-badge&logo=nestjs&logoColor=white" />
</a>
</div>
<br/>

<div align="center"><img src="https://github.com/COS301-SE-2023/WriteToPdf/assets/104741835/c151ddb6-fc79-4366-87ea-f91a033dfe10" /></div>

<!-- App ad -->
## WriteToPdf advertisement
## :movie_camera: WriteToPdf advertisement
https://github.com/COS301-SE-2023/WriteToPdf/assets/104741835/bcbb9573-0dbd-4e79-8830-f0e11453c501
## Description

WriteToPdf is a user-friendly ecosystem that enables the conversion of handwritten notes into structured documents that can be edited and shared with others.

<!-- ## Demos
- [Demo 1](https://drive.google.com/drive/folders/1D8awdHGBDuI7PGQYF_jtX9iGq_9PWY3x?usp=sharing)
- [Demo 2](https://drive.google.com/drive/folders/1QVIrOEi5PJAhG8DMwNrwjIcF7Gocu8LK?usp=sharing)
- [Demo 3](https://drive.google.com/drive/folders/1cW53_1X3Y5Wp2fSbiyTv9ax8rGFM-JwM?usp=sharing)
- [Demo 4](https://drive.google.com/drive/folders/1-VIEUnEXivpa1MBX3zZxIqFsuRqCtaOw?usp=sharing) -->

## Documentation
## :clipboard: Description
WriteToPdf is an app designed to make your life easier by converting your handwritten
notes and documents into digital text that you can easily edit, store, and share. Our app
uses optical character recognition (OCR) technology to accurately recognize handwriting
and convert it into digital text. It also provides a web-based browser editor and saves all
your information and documents online.
The rich text editor will allow you to make alterations to the scanned in text as well as
append scanned text to documents that are already in progress. From there, one can
export each document to different document formats, which include PDF, markdown,
HTML, text and image formats.
Our app is capable of recognizing tables, making it easier to create, organise and format
your notes and documents. First implementations of the app will aim to achieve the
OCR and table recognition functionality. However, in the future, we're planning to add
features that will allow our app to recognize images and drawings on handwritten
notes, making it easier to capture your ideas and creations in a digital format.

## :books: Documentation
- ### [Software requirements specification](https://drive.google.com/drive/folders/17r0LoH5KJNISI1NUesoqVGlmE09viezb?usp=sharing)

- ### [Coding standards](https://drive.google.com/drive/folders/1oG067cCYEsS29nzmAEv_lH5uiQO1Nm7L?usp=sharing)
Expand All @@ -54,55 +57,20 @@ WriteToPdf is a user-friendly ecosystem that enables the conversion of handwritt

- ### [User Manual](https://drive.google.com/drive/folders/1j0s5OuKmb1sx3fOYqxAA3ZbO3ITTMOs9?usp=sharing)

### Organisation & Management
## :briefcase: Organisation & Management
We use <a href="https://github.com/COS301-SE-2023/WriteToPdf/issues">Github Issues</a> and <a href="https://github.com/COS301-SE-2023/WriteToPdf/projects?query=is%3Aopen">Github Projects</a> to organise our team, with different members being assigned to specific tasks to ensure effective use of each member’s time.

<!-- ### Architecture
- [Architecture v1](https://docs.google.com/document/d/1skoEPk1VvtO8P9fyWIVFyUuf0ssU1aI8G-wrYYNbeyg/edit?usp=sharing)
- [Architecture v2](https://docs.google.com/document/d/1FTGkhilcBonjeJdZc6e2ykf3x_l8cgZlwjZvC8O_KZ8/edit?usp=sharing)
- [Architecture v3](https://docs.google.com/document/d/1vsMHJwqzcz90eAQDmRtiRptpSUpqpPzTstwP2HO-iX4/edit?usp=sharing)
### Technical installation document
- [Technical installation v1](https://docs.google.com/document/d/1HG9QVSEh2NsHbrRTlXPBjiq3keQMapmmiDbTFK07tNU/edit?usp=sharing) -->

<!-- ### Member contributions
- [Member contributions](https://docs.google.com/document/d/14n7aEG_Lwh3dXSq6ltJ8XE_rzAREMGsH-3B-crGn2fM/edit?usp=sharing) -->

<!-- ## Branching strategy
The main branch is the live/deployed branch.
Test branch is used to run all tests. These two branches are the stable branches.
The codecov branch is used to merge completed features into and is the branch where tests get fixed before being pushed to the Test branch.
Feature branches get created off of the Test branch and be called dev/feature_name. Once a feature is completed it gets merged into codecov.
The flow of merging is: dev/feature -> codecov -> test -> main
## Repository Structure
The repository follows a well-organised structure to meet our client's requirements and ensures efficient development and maintenance. It consists of the following folders:
```
.
|-- /frontend
|-- /backend
|-- /infrastructure
```
The `frontend` folder holds all the code related to the user-facing interface and the client-side functionality. This includes HTML, CSS, JavaScript, and any relevant assets.
The `backend` folder contains the server-side code responsible for handling data processing, business logic, and integration with external services. This includes server-side programming languages, frameworks, and libraries.
To address the need for infrastructure as code, the `infrastructure` folder houses all the necessary configurations and scripts for provisioning and managing the underlying infrastructure components. This allows for automated and reproducible deployment and scaling of the application.
By structuring the repository in this manner, we maintain a clear separation of concerns, enabling efficient collaboration and ease of maintenance across different parts of the project. -->

## Team Members
## :busts_in_silhouette: Team Members
<img src="https://user-images.githubusercontent.com/104741835/235907674-681152ec-0f46-4b1d-8c3b-4478a2e6290e.png" />
<details>
<summary>Janco Spies - u21434159</summary>
<br>
<p>Project Leader, Tester, Integration Engineer</p>
<p>
Janco has experience working as a tutor for the module Data Structures and Algorithms at the University of Pretoria, where he enjoys problem-solving and collaborating with others. Janco has excelled academically during his time at the university and has a strong background in statistics. He is skilled in several programming languages and frameworks, including Java, NodeJS, C++, Angular, and Python.
Janco is a well motivated and level headed developer with an eye for detail. He has excelled academically during his time at the university and has a strong background in statistics. He is skilled in several programming languages and frameworks, including Java, NodeJS, C++, Angular, and Python.
</p>
<a href="mailto:[email protected]">[email protected]</a>
<br/>
<br/>
<a href="https://www.linkedin.com/in/ACoAADDlAbMBzAMuf8KIqa4ZdJtrDAi1qu4EPz4?lipi=urn%3Ali%3Apage%3Ad_flagship3_feed%3B1J9zjGT%2FSHeIpMlnKxWZvA%3D%3D">
<img src="https://img.shields.io/badge/linkedin-0a66c2?style=for-the-badge&logo=linkedin&logoColor=white" alt="Linkedin"/>
Expand All @@ -123,6 +91,8 @@ Janco has experience working as a tutor for the module Data Structures and Algor
<p>
Jake is a self-motivated and passionate individual who is highly enthusiastic about the practical applications of data science, machine learning and product design. He has experience as a tutor for the module Mathematical Modelling at the University of Pretoria where he tutored students in Pythonic data science. He has experience building, managing and integrating NoSQL databases, such as Google Cloud Firestore and MongoDB. He also has experience building APIs in PHP and Typescript through NestJS. Jake’s other relevant skills include Java, NestJS, Angular, C++ and LaTeX.
</p>
<a href="mailto:[email protected]">[email protected]</a>
<br/>
<br/>
<a href="https://www.linkedin.com/in/ACoAADrYSskBc41A9bb97Sym87rcIbAqpKdQOY4/?lipi=urn%3Ali%3Apage%3Ad_flagship3_profile_view_base%3BmboD%2FrmkRsKFxJTOheSOsQ%3D%3D">
<img src="https://img.shields.io/badge/linkedin-0a66c2?style=for-the-badge&logo=linkedin&logoColor=white" alt="Linkedin"/>
Expand All @@ -143,6 +113,8 @@ Jake is a self-motivated and passionate individual who is highly enthusiastic ab
<p>
Dylan is a highly motivated individual with a solid academic background, finishing the second half of his 3rd year with a 75% average. He is proficient in a wide range of technologies, including: Python, C++, Java, ASM, JavaScript/TypeScript, Rust, PHP, Angular, NodeJS, Jest, and Cypress. His experience extends to tools and platforms such as Docker, Home Server maintenance, LaTeX, Doxygen, Google Cloud, and CI/CD workflows using GitHub Actions. Dylan is passionate about applying his technical expertise in diverse projects and environments, and he is always eager to learn and adopt new technologies.
</p>
<a href="mailto:[email protected]">[email protected]</a>
<br/>
<br/>
<a href="https://www.linkedin.com/in/dylan-kapnias-b41ab2277?lipi=urn%3Ali%3Apage%3Ad_flagship3_profile_view_base_contact_details%3BDLZJVIFfQUyfGT%2FfBspbpg%3D%3D">
<img src="https://img.shields.io/badge/linkedin-0a66c2?style=for-the-badge&logo=linkedin&logoColor=white" alt="Linkedin"/>
Expand All @@ -163,6 +135,8 @@ Dylan is a highly motivated individual with a solid academic background, finishi
<p>
Conrad is an avid programmer, yogi and musician. He has experience in Python, R, MATLAB, C++, Java, Angular, React, Google Cloud and Docker. He has programmed an algorithmic music generator, whose music functions as accompaniment for musical improvisation, with Python as part of a master’s project collaboration at Tuks. His speciality is reading up on domain specific knowledge and implementing innovative solutions within that domain, as with the music application.
</p>
<a href="mailto:[email protected]">[email protected]</a>
<br/>
<br/>
<a href="https://www.linkedin.com/in/conrad-strasheim-81810a26a?miniProfileUrn=urn%3Ali%3Afs_miniProfile%3AACoAAEHeNBQBIAgklS52yGZGLqg_dsFeSpaTy84&lipi=urn%3Ali%3Apage%3Ad_flagship3_search_srp_all%3BIrFwHOqPRhixjO%2F3SKDhWA%3D%3D">
<img src="https://img.shields.io/badge/linkedin-0a66c2?style=for-the-badge&logo=linkedin&logoColor=white" alt="Linkedin"/>
Expand All @@ -180,11 +154,11 @@ Conrad is an avid programmer, yogi and musician. He has experience in Python, R,
<summary>Julian Pienaar - u21599892</summary>
<br/>
<p>UI Engineer, Integration Engineer, Designer</p>

<p>
Julian has experience with design patterns and data structures giving him a good understanding of algorithms. He has worked on large Angular projects as a UI Engineer. He has a high capacity to learn and understand complex ideas and is able to adapt to the change. He is proficient in multiple languages and frameworks such as C++, Java, NodeJS, Php, Javascript, Ionic, Angular and Typescript.
Julian has experience with design patterns and data structures giving him a good understanding of algorithms. He has worked on large Angular projects as a UI Engineer. He has a high capacity to learn and understand complex ideas and is able to adapt to change. He is proficient in multiple languages and frameworks such as C++, Java, NodeJS, Php, Javascript, Ionic, Angular and Typescript.
</p>

<a href="mailto:[email protected]">[email protected]</a>
<br/>
<br/>
<a href="https://www.linkedin.com/in/julian-pienaar-370208271/?lipi=urn%3Ali%3Apage%3Ad_flagship3_feed%3B0NeumpYtT8e%2FsXo8GIBScQ%3D%3D">
<img src="https://img.shields.io/badge/linkedin-0a66c2?style=for-the-badge&logo=linkedin&logoColor=white" alt="Linkedin"/>
Expand All @@ -196,34 +170,30 @@ Julian has experience with design patterns and data structures giving him a good

</details>

<!-- Slideshow summary -->
## System demo
## :computer: System demo
https://github.com/COS301-SE-2023/WriteToPdf/assets/104741835/33c8263d-6e23-4c1d-b1a3-eff914980128

<!-- Research done -->
## Research and implementation decisions
## :mag: Research and implementation decisions
- [Document locking research](https://drive.google.com/file/d/1kkVQzP3eiXK1t5KRCnXK4471cWeke4-i/view?usp=sharing)
- [OCR decision reasoning](https://drive.google.com/file/d/12nViCbehOyc1xuqCYJMqHlwV7nDkBPzB/view?usp=sharing)
- [Version control decision reasoning](https://drive.google.com/file/d/11v_9_doxd0K_wDmfm3wkOM8SvyXMbERM/view?usp=sharing)

<!-- Deployment info -->
## Deployed system
## :globe_with_meridians: Deployed system
Our live system can be found at: [app.writetopdf.com](https://app.writetopdf.com)

<!-- How to download/install and use -->
## How to Use WriteToPdf
## :question: How to Use WriteToPdf
[How to use WriteToPdf Wiki](https://github.com/COS301-SE-2023/WriteToPdf/wiki/How-to-use-WriteToPdf)

<!-- Tutorial of system -->
## System tutorial
## :bulb: System tutorial
https://github.com/COS301-SE-2023/WriteToPdf/assets/104741835/5bad46b5-1ad8-48a4-8715-1a7825eca0d1

<!-- How to participate in development -->
## Contributing
## :handshake: Contributing
To contribute to our project, start by creating a clear and detailed issue, then fork the repository to your GitHub account. Work on your changes in a new branch and be sure to follow our coding standards to maintain code quality. Afterward, open a pull request targeting the `codecov` branch, and don't forget to review our [coding standards document](https://drive.google.com/file/d/12SWhFWNj9fA0ErqLug3xC_OroPj_6y5e/view?usp=sharing) to ensure your code aligns with our guidelines before submitting your pull request for review. Your contributions are greatly appreciated and help us improve our project.

Feel free to contact us at: [[email protected]](mailto:[email protected])

<details>
<summary>Secret Message</summary>
<summary> :lock: Secret Message</summary>
<br/>
<p>Good luck to the Capstone Groups of 2024! :smile:</p>
</details>

0 comments on commit 8ac2f3e

Please sign in to comment.