Welcome to the repository for SimplyWords! SimplyWords is an Android app made to make it easier for senior Singaporeans who have difficulty comprehending content on digital services. It is an app made to simplify and rewrite text to increase readability and understandability. This project is created as part of the Portfolio Development module at Ngee Ann Polytechnic. To learn more about it, watch this video here. (Note: You need an NP staff or student account for this!)
As part of the module, we were given a sponsor that presented us with a problem statement. The statement was:
Closing the digital divide for common services
Based on this, we decided to focus on the elderly in Singapore. We found that many elderly Singaporeans have difficulty understanding content, mainly because many of them aren't well-versed in English, and many digital services are not available in other languages. We decided to create an app that would help to simplify and rewrite text to increase readability and understandability.
-
We use the OpenAI API to simplify and rewrite text. You will need to create an account and get an API key from the OpenAI Platform. If paid less than $5, there is significant chance that rate limits will be hit. Create a
env.propertiesfile like so:OPENAI_KEY="YOUR API KEY HERE" -
Clone the repository to a desired location on your computer:
git clone https://github.com/SimplyWordsTeam/SimplyWords
-
Launch the project in Android Studio.
-
Run the project on an emulator or physical device by clicking the "Run" button and the top right corner of the screen.
Since this is a graded project for a module, we will not be accepting any contributions. However, if you have any suggestions or feedback, feel free to open an issue or contact us! We will be happy to hear from you.
While this project is open source, in the context that this is a project for academic purposes, the intention is to provide transparency and visibility into the codebase than to encourage widespread reuse of the codebase. Therefore, we do not provide any license for this project. If you wish to use any part of this project, let us know!