-
Notifications
You must be signed in to change notification settings - Fork 3
Reports
Table of Contents
- Introduction
- Community Bonding Period
- Coding Period
- Week 1
- Week 2
- Week 3
- Week 4
- Week 5
- Week 6
- Week 7
- Week 8
- Week 9
In this section I will keep a weekly report, to keep track of the tool's progress. As part of GSoC 2019, the project followed a strict timeline of a 20 day long bonding period and a 12 weeks long coding period. The bonding period spawned from 6/5 to 26/5, while the coding period lasted from 27/5 to 27/8.
At the beginning of this period, I had a meeting with my mentors in which we clarified the goals of the project and we discussed about the tools that I would use.
Throughout the rest of the bonding period, I read the documentation of the packages, the libraries and the frameworks I would use and I created a basic, testing app with a readability indices extraction feature.
During the first week (27/5-2/6), I had a meeting with my mentors where we organized my working order, changing the project's timeline a bit. I started working on the app, adapting and organizing the code I've written so far. Also, I further developed the extraction and the format of readability indices and I implemented a way for the user to add custom scripts to be applied on the selected files.
During the second week (3/6-9/6), I had a meeting with one of my mentors to clarify some things about the readability indices. Considering the app, I implemented a way to store user data and settings (window position, window size and system paths of important executables). Moreover, I've added a side navigation bar and I did an overall component reorganization to have further scalability and flexibility. Finally, I included lexical diversity indices and I added a results tab which displays the scripts' output.
During the third week (10/6-16/6), I fixed some issues with the results tab (support for multiple files, async execution) and I worked on data storage and management. More specifically, I set up a MongoDB database in order to store and access the scripts' results and integrated it fully to the application. Also, I've added some style, using CSS.
During the fourth week (17/6-23/6), I added the vocabulary list to the database and I included some additional indices like entropy and normalized entropy to the tool. Also, since the tokens and the vocabulary of a text are so crucial to the rest of the analysis, I made their calculation compulsory.
During the fifth week (24/6-30/6), I decided to integrate a UI framework. More specifically, I've done the necessary actions and adaptions to include Material-UI framework to the tool, while keeping the same functionality. Additionally, I added documentation and comments and made some structural changes in order for the app to be ready for the first evaluation.
From this point onward, my weekly work routine contained many bug fixes and issue solving that are not explicitly written down.
During the sixth week (1/7-7/7), I adapted the result page to display only the selected indices and I worked on the files tab, adding checkboxes for file selection and storing file data in the database.
During the seventh week (8/7-14/7), I added a delete button for input files in order to permanently remove a file from the database, I implemented sorting for both input and results table and created a basic console component for message output.
During the eighth week (15/7-21/7), I implemented a way to export the calculated results in json and csv format. Additionally, I finished the console component and integrated it to the app.
During the ninth week (22/7-28/7), I added a way to display the lists of tokens and of the vocabulary of each text. Also, I made a full rework of the custom script tab by making a proper custom script builder and by saving script information for future uses.
During the ninth week (29/7-4/7), I worked on the styling and visual customization of the app.