DMP 2024

[lalbelda]

Description

Oky is the world’s first period tracker app for girls and created with girls. It provides information about menstruation in fun, creative and positive ways, straight into girls’ hands through the tools they use every day – mobile phones. Oky lets girls feel in control and more confident by tracking their periods, and getting the information that all girls should know.

Goals

Create global analytics dashboard to display analytics of Oky users worldwide.

Detailed objectives:

• Fetch user analytics data periodically from the CMSs of various countries.
• Display the data in a dashboard using an open source visualization platform, such as Apache Superset.
• Fetch total number of users from every country's Firebase and display that on a dashboard using an open source visualization platform, such as Apache Superset.

Expected Outcome

Detailed expected outcomes

• Develop a Node app, written in TypeScript, to maintain consistency with the rest of the project. This app will:
  • Once every 2 weeks, send HTTP requests to fetch user analytics data from the CMSs of multiple countries. Can send requests to /analytics-management with this header headers: { Accept: 'application/json'} and you will get JSON data thats used for that page
  • Add button so users can fetch data from CMS' in real time (on the spot). If a CMS is down, display previous data stored and inform CMS user that no new data for a given country can be fetched.
  • Store the data from these requests (e.g., save JSON files in S3 storage) to ensure that, even if a CMS goes down, the dashboard can still display the most recently fetched data.
  • Use an open source visualization platform such as Apache Superset to display the data in a dashboard.
  • Pull data for total number of users from each Firebase analytics dashboard and display it on an open source visualization platform, such as Apache Superset.

Security considerations when developing solution:

1. storing the JSON is private
2. requests to the CMS require authentication
3. requests are sent via HTTPS
4. the usernames/passwords are kept in a .env file or secrets management equivalent

Acceptance criteria

• Typescript is used
• Data is fetched once every 2 weeks from multiple CMSs
• Data is saved on the database so that it can be displayed in case a CMS goes down. If a given country's CMS is down, display previous stored data but warn user on the data visualization tool that for that country, no new data has been fetched as CMS is down.
• Implement error handling for failed data fetches
• Data is displayed in an open source visualization dashboard such as Apache superset
• Data regarding total number of users pulled from Firebase and displayed on open source visualization dashboard

Setup/Installation
Please follow the readme in the code

Mockups / Wireframes
NA

Product Name
Oky

Project Name
Oky

Organization Name:
Unicef

Domain
okyapp.info

Tech Skills Needed:
React Native, Node, Typescript, Postgres

Mentor(s)

Complexity
High

Category

Sub Category

[giri-0311]

Hey @lalbelda I would like to work on this .
I am dedicated to complete this project in the expected timeframe.

[kc-m13]

Hi @lalbelda,

I hope this message finds you well. My name is Manjot Kaur Channi, and I'm a pre final year student at NIT Delhi pursuing my majors in Electronics and Communication Engineering and a minor degree in AI/ML. I recently came across the Oky project, focusing on creating a global analytics dashboard for the Oky period tracker app. The initiative to empower girls with valuable insights through the Oky app resonates deeply with me, and I'm eager to contribute to its success. My experience with projects in React, Node, TypeScript and MySQL positions me well to tackle the technical challenges of this project.

I'm particularly excited about the opportunity to work on implementing security measures, fetching and analyzing user analytics data, and displaying it in an intuitive dashboard using Apache Superset (which is something I havnt tried yet but Im keen on learning). Could you please provide additional details on how I can get involved and contribute effectively to the Oky project? I'm keen to learn more about the goals, requirements, and timeline.

Thank you for considering my interest, and I look forward to hearing from you soon.

Best regards,
Manjot Kaur Channi

[lalbelda]

Good afternoon, @giri-0311 @kc-m13 please remember the interest needs to be submitted via official portal: https://unstop.com/competitions/dedicated-mentoring-program-dmp-2024-code-for-govtech-932803?lb=7gWXVfKv

Thanks,

Lucia

[AbhimanyuSamagra]

Do not ask process related questions about how to apply and who to contact in the above ticket. The only questions allowed are about technical aspects of the project itself. If you want help with the process, you can refer instructions listed on Unstop and any further queries can be taken up on our Discord channel titled DMP queries. Here's a Video Tutorial on how to submit a proposal for a project.

[Sumsum1231]

Good afternoon, @giri-0311 @kc-m13 please remember the interest needs to be submitted via official portal: https://unstop.com/competitions/dedicated-mentoring-program-dmp-2024-code-for-govtech-932803?lb=7gWXVfKv

Thanks,

Lucia

Greetings,
I want to know more about the project may we connect please ?

[SiddhantSathe]

Hi @lalbelda,
I hope this message finds you well, I want to work on this project.
I was going through the README.md of the project. In that in Install Software Dependencies section, it is given as 'These instructions assume that you are using an apple Mac.' and also in required section Xcode is mentioned. So, I have a windows laptop and is it a necessity to have a MacOS?

[lalbelda]

To be delivered by 15th July

• Ability to pull data for total number of users from Firebase analytics (total users under audiences, number of users by country, MAU and DAU), using Firebase API. So setup the code for this so we can do it for each of Firebase instances

To be delivered by 28th Jul

• Develop a Node app, written in TypeScript that can send HTTP requests to fetch user analytics data from the CMSs of multiple countries. Can send requests to /analytics-management with this header headers: { Accept: 'application/json'} and you will get JSON data thats used for that page