Skip to content

Instantly share code, notes, and snippets.

@akshatnitd

akshatnitd/akshatnitd_GSoc18_Final_Report.md

Last active August 18, 2018 12:20
Download ZIP

Revisions

  1. akshatnitd revised this gist Aug 18, 2018. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion akshatnitd_GSoc18_Final_Report.md
    View file
    Original file line number Diff line number Diff line change
    @@ -120,7 +120,7 @@ Revamped the entire UI/UX of the Skills CMS web client. Used standard components
    - **Project Presentation** : [Link](https://docs.google.com/presentation/d/15vTd5Eo_NDQxogp1ToVF5z_-CQC2SCH1curgPncXapE/edit?usp=sharing)
    - **Screencast Phase 1** : [Link](https://drive.google.com/open?id=1ZZk89cIZ8kTZXia1xpEVeezcgMF3Qhap)
    - **Screencast Phase 2** : [Link](https://drive.google.com/open?id=1ryISnQrY_3AnbX_rpzqaeaFUcKrrG4Sc)
    - **Screencast Phase 3** : [Link]()
    - **Screencast Phase 3** : [Link](https://drive.google.com/open?id=1GQ07Q3a9j_qAZsd38Vzr1fgXV4F9fQRf)
    - **Outreach Event 1** : [Eventyay](https://eventyay.com/e/e725250f/) | [Twitter](https://twitter.com/tweet_akshat/status/1000977063271157760) | [Facebook](https://www.facebook.com/events/452031158586076/)
    - **Outreach Event 2** : [Eventyay](https://eventyay.com/e/bf220fe3/) | [Twitter](https://twitter.com/tweet_akshat/status/1014383501880070145) | [Facebook](https://www.facebook.com/events/622238461481446/)
    - **Outreach Event 3** : [Eventyay](https://eventyay.com/e/408afb7b/) | [Twitter](https://twitter.com/tweet_akshat/status/1026192367265636352) | [Facebook](https://www.facebook.com/events/822726417851586/)
  2. akshatnitd revised this gist Aug 13, 2018. No changes.
  3. akshatnitd created this gist Aug 13, 2018.
    128 changes: 128 additions & 0 deletions akshatnitd_GSoc18_Final_Report.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,128 @@
    <img src="https://developers.google.com/open-source/gsoc/resources/downloads/GSoC-logo-horizontal.svg">
    <p float="left" align="center">
    <img width="25%" padding="20" src="https://i.imgur.com/VDt51mZ.png"> &nbsp&nbsp&nbsp&nbsp&nbsp
    <img width="35%" padding="20" src="https://i.imgur.com/pFfAAYE.png">
    </p>

    ## GSoC 2018 Work Report

    - **Student**: Akshat Garg
    - **Github**: [@akshatnitd](https://github.com/akshatnitd)
    - **Organisation**: [FOSSASIA](https://fossasia.org/)
    - **Project**: [SUSI Analytics](https://summerofcode.withgoogle.com/projects/#5102830482882560)

    ## Aim
    Develop an analytics dashboard for [SUSI.AI](https://susi.ai) that would display various statistics/analytics based on standard metrics for skills and conversations on SUSI.AI.

    ## Overview of Work Done

    ### Multiple features for SUSI Skills
    Implemented multiple features on [SUSI Skills CMS](https://skills.susi.ai) and created corresponding APIs on the [SUSI Server](https://api.susi.ai). Some of the features are as follows :
    - Implemented five star skill rating system.
    - Implemented skill feedback system.
    - Implemented feature to report a skill.
    - Added functionality to directly test the skill examples on [SUSI Web-chat](https://chat.susi.ai).
    - Feature to upload/get avatar of a user.
    - Added functionalities to the SUSI Admin Panel.

    ### Metrics based skill display
    Displayed skills based on standard metrics on the home screen of SUSI skills CMS. The metrics are as follows :
    - Usage count
    - Newly created
    - Latest updated
    - Highest rated
    - Feedback count
    - Staff pick

    ### Representation of collected data
    Displayed various statistics like skill usage and skill ratings on the skill details screen. The added data representational models are as follows :
    - Bar graph for skill rating
    - Line graph for time wise usage
    - Pie chart for device wise usage
    - Heat map for country wise usage, etc
    - Line graph for ratings received over time

    ### Revamped UI of the Skills CMS client
    Revamped the entire UI/UX of the Skills CMS web client. Used standard components from the [Material-UI](https://v0.material-ui.com) library. Some of the changes are as follows :
    - Added a sidebar containing various filters and categories on the home screen.
    - Created separate pages and React routes for category wise skills and language wise skills.
    - Implemented option to switch between list view and card view on skills listing page.
    - Displayed overall stats on the admin panel.
    - Added various filters to sort the skills based on a list of options.
    - Made enhancements to the 'My Dashboard' section.


    ## Code contributions in SUSI Projects

    ### SUSI.AI Skill CMS
    - **Github Repository** : [fossasia/susi_skill_cms](https://github.com/fossasia/susi_skill_cms)
    - **Technologies used** : ReactJs, Material-UI
    - **Project link** : [https://skills.susi.ai](https://skills.susi.ai)
    - **Issues opened** : [Link](https://github.com/fossasia/susi_skill_cms/issues?utf8=%E2%9C%93&q=is%3Aissue+author%3Aakshatnitd)
    - **Pull Requests sent** : [Link](https://github.com/fossasia/susi_skill_cms/pulls?utf8=%E2%9C%93&q=is%3Apr+author%3Aakshatnitd+)
    - **Commits made** : [Link](https://github.com/fossasia/susi_skill_cms/commits?author=akshatnitd)

    ### SUSI.AI Server
    - **Github Repository** : [fossasia/susi_server](https://github.com/fossasia/susi_server)
    - **Technologies used** : JAVA, Jetty Server, JAVA Servlets
    - **Project link** : [https://api.susi.ai](https://api.susi.ai)
    - **Issues opened** : [Link](https://github.com/fossasia/susi_server/issues?utf8=%E2%9C%93&q=is%3Aissue+author%3Aakshatnitd)
    - **Pull Requests sent** : [Link](https://github.com/fossasia/susi_server/pulls?utf8=%E2%9C%93&q=is%3Apr+author%3Aakshatnitd+)
    - **Commits made** : [Link](https://github.com/fossasia/susi_server/commits?author=akshatnitd)

    ### SUSI.AI Web-Chat
    - **Github Repository** : [fossasia/chat.susi.ai](https://github.com/fossasia/chat.susi.ai)
    - **Technologies used** : React, Flux, Material-UI
    - **Project link** : [https://chat.susi.ai](https://chat.susi.ai)
    - **Issues opened** : [Link](https://github.com/fossasia/chat.susi.ai/issues?utf8=%E2%9C%93&q=is%3Aissue+author%3Aakshatnitd)
    - **Pull Requests sent** : [Link](https://github.com/fossasia/chat.susi.ai/pulls?utf8=%E2%9C%93&q=is%3Apr+author%3Aakshatnitd+)
    - **Commits made** - [Link](https://github.com/fossasia/chat.susi.ai/commits?author=akshatnitd)

    ### SUSI.AI Accounts
    - **Github Repository** : [fossasia/accounts.susi.ai](https://github.com/fossasia/accounts.susi.ai)
    - **Technologies used** : React, Flux, Material-UI, Ant Design
    - **Project link** : [https://accounts.susi.ai](https://accounts.susi.ai)
    - **Issues opened** : [Link](https://github.com/fossasia/accounts.susi.ai/issues?utf8=%E2%9C%93&q=is%3Aissue+author%3Aakshatnitd)
    - **Pull Requests sent** : [Link](https://github.com/fossasia/accounts.susi.ai/pulls?utf8=%E2%9C%93&q=is%3Apr+author%3Aakshatnitd+)
    - **Commits made** - [Link](https://github.com/fossasia/accounts.susi.ai/commits?author=akshatnitd)


    **Screenshots**

    | Home page | Category page (List view) |
    | --- | --- |
    |<img src="https://i.imgur.com/FJQgvRy.png">|<img src="https://i.imgur.com/pale3wH.png">|

    | Category page (Grid view) | Search Results |
    | --- | --- |
    |<img src="https://i.imgur.com/4Ded6f8.png">|<img src="https://i.imgur.com/aeaIFk0.png">|

    | My Dashboard | My Analytics section |
    | --- | --- |
    |<img src="https://i.imgur.com/HQbB6YB.png">|<img src="https://i.imgur.com/DykXqmb.png">|

    | Skill Details Page | Rating section |
    | --- | --- |
    |<img src="https://i.imgur.com/Wt4nmRw.png">|<img src="https://i.imgur.com/mfZunD8.png">|

    | Feedback section | Skill Usage section |
    | --- | --- |
    |<img src="https://i.imgur.com/ilx51qJ.png">|<img src="https://i.imgur.com/hLfT0Ya.png">|

    | Skill Usage section | Report Skill |
    | --- | --- |
    |<img src="https://i.imgur.com/yRAdKfi.png">|<img src="https://i.imgur.com/oIeIeMv.png">|


    ### Other deliverables
    - **Daily Scrums** : [A list of all the scrums during the GSoC period](https://groups.google.com/forum/#!searchin/susiai/Akshat$20Garg%7Csort:date)
    - **Blog Posts** : [Link](http://blog.fossasia.org/author/akshatnitd/)
    - **Project Presentation** : [Link](https://docs.google.com/presentation/d/15vTd5Eo_NDQxogp1ToVF5z_-CQC2SCH1curgPncXapE/edit?usp=sharing)
    - **Screencast Phase 1** : [Link](https://drive.google.com/open?id=1ZZk89cIZ8kTZXia1xpEVeezcgMF3Qhap)
    - **Screencast Phase 2** : [Link](https://drive.google.com/open?id=1ryISnQrY_3AnbX_rpzqaeaFUcKrrG4Sc)
    - **Screencast Phase 3** : [Link]()
    - **Outreach Event 1** : [Eventyay](https://eventyay.com/e/e725250f/) | [Twitter](https://twitter.com/tweet_akshat/status/1000977063271157760) | [Facebook](https://www.facebook.com/events/452031158586076/)
    - **Outreach Event 2** : [Eventyay](https://eventyay.com/e/bf220fe3/) | [Twitter](https://twitter.com/tweet_akshat/status/1014383501880070145) | [Facebook](https://www.facebook.com/events/622238461481446/)
    - **Outreach Event 3** : [Eventyay](https://eventyay.com/e/408afb7b/) | [Twitter](https://twitter.com/tweet_akshat/status/1026192367265636352) | [Facebook](https://www.facebook.com/events/822726417851586/)

    **Thank you [FOSSASIA](https://github.com/fossasia) and Google for giving me this wonderful opportunity! :smiley:**