Google Summer of Code 2019/Web UI improvements: Difference between revisions

From Software Heritage Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
== Title: Web UI improvements ==
== Title: Web UI improvements ==


* '''Description:''' Software Heritage can be accessed through a beautiful and rich Web UI, developed in Django. This project was aimed at improving the web interface (swh-web).
===Description===
Software Heritage can be accessed through a beautiful and rich Web UI, developed in Django. This project was aimed at improving the web interface (swh-web).


* '''Student: Kalpit Kothari'''
===Student===
** [https://forge.softwareheritage.org/p/kalpitk/ Forge Activity]
* Name : Kalpit Kothari
** [https://wiki.softwareheritage.org/wiki/Google_Summer_of_Code_2019/Web_UI_improvements/Commit_list List Of Commits]
* [https://forge.softwareheritage.org/p/kalpitk/ Forge Activity]
* [https://wiki.softwareheritage.org/wiki/Google_Summer_of_Code_2019/Web_UI_improvements/Commit_list List Of Commits]


* '''Mentors:'''
===Mentors===
** Antoine Lambert
* Antoine Lambert
** Valentin Lorentz
* Valentin Lorentz


===Work highlights===
* Security testing : Various XSS vulnerabilities were fixed in the website.


* '''Work highlights'''
* End-to-end Testing :  
** Security testing : Various XSS vulnerabilities were fixed in the website.
** End-to-end tests were written for the website in Cypress (JavaScript framework).
** End-to-end Testing : End-to-end tests were written for the website in Cypress (JavaScript framework). 71 percent JavaScript code coverage was achieved. These are end-to-end test are already being being executed for each swh-web diff.
** 71 percent JavaScript code coverage was achieved.
** Other Improvements : Language select option, improve responsiveness, some UI enhancements, improve image & pdf rendering, redirection for uppercase hash
** These are end-to-end test are already being being executed for each swh-web diff.


* '''What's left'''
* Other Improvements : Language select option, improve responsiveness, some UI enhancements, improve image & pdf rendering, redirection for uppercase hash
** We stand a bit away from 80% code coverage mark for the front-end JavaScript. There is scope of adding more cypress tests.
** Origin search interface may be further improved. Some tests are already written for the same which should make the task easier.
** Update of readme with information about end-to-end tests.


===What's left===
* We stand a bit away from 80% code coverage mark for the front-end JavaScript. There is scope of adding more cypress tests.
* Origin search interface may be further improved. Some tests are already written for the same which should make the task easier.
* Update of readme with information about end-to-end tests.


* '''Activity reports:'''
** May 2019
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-05/msg00006.html Week 21 (Community Bonding)]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-05/msg00016.html Week 22]
** June 2019
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00008.html Week 23]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00015.html Week 24]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00025.html Week 25]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00032.html Week 26 (First Evaluation)]
** July 2019
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00002.html Week 27]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00004.html Week 28]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00010.html Week 29]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00016.html Week 30 (Second Evaluation)]
** August 2019
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-08/msg00001.html Week 31]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-08/msg00005.html Week 32]
*** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-08/msg00007.html Week 33]
*** Week 34 (Final Evaluation)


== Links ==
==Links ==


* [https://forge.softwareheritage.org/source/swh-web/ swh-web]
* [https://forge.softwareheritage.org/source/swh-web/ swh-web repository]
* see project [https://summerofcode.withgoogle.com/projects/#5266890438475776 on the GSoC portal]
* see project [https://summerofcode.withgoogle.com/projects/#5266890438475776 on the GSoC portal]
===Activity reports===
* May 2019
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-05/msg00006.html Week 21 (Community Bonding)]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-05/msg00016.html Week 22]
* June 2019
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00008.html Week 23]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00015.html Week 24]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00025.html Week 25]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-06/msg00032.html Week 26 (First Evaluation)]
* July 2019
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00002.html Week 27]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00004.html Week 28]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00010.html Week 29]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-07/msg00016.html Week 30 (Second Evaluation)]
* August 2019
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-08/msg00001.html Week 31]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-08/msg00005.html Week 32]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-08/msg00007.html Week 33]
** [https://sympa.inria.fr/sympa/arc/swh-devel/2019-08/msg00012.html Week 34 (Final Evaluation)]




[[Category:Google Summer of Code]]
[[Category:Google Summer of Code]]
[[Category:Google Summer of Code 2019]]
[[Category:Google Summer of Code 2019]]

Latest revision as of 17:03, 28 August 2019

Title: Web UI improvements

Description

Software Heritage can be accessed through a beautiful and rich Web UI, developed in Django. This project was aimed at improving the web interface (swh-web).

Student

Mentors

  • Antoine Lambert
  • Valentin Lorentz

Work highlights

  • Security testing : Various XSS vulnerabilities were fixed in the website.
  • End-to-end Testing :
    • End-to-end tests were written for the website in Cypress (JavaScript framework).
    • 71 percent JavaScript code coverage was achieved.
    • These are end-to-end test are already being being executed for each swh-web diff.
  • Other Improvements : Language select option, improve responsiveness, some UI enhancements, improve image & pdf rendering, redirection for uppercase hash

What's left

  • We stand a bit away from 80% code coverage mark for the front-end JavaScript. There is scope of adding more cypress tests.
  • Origin search interface may be further improved. Some tests are already written for the same which should make the task easier.
  • Update of readme with information about end-to-end tests.


Links

Activity reports