flip-fest
flip-fest copied to clipboard
CryptoDappy Feature: localization (I18n) solution
👋 If you are interested in working on this issue, please check out the Getting Started guide on HackerEarth!
Description (Problem Statement)
CryptoDappy is a community-owned learning application for Flow. As our international audience grows, we would like to offer our learning content in different languages. Community members have already published some translated documents (e.g. Vietnamese version), but the basic functionality of changing the language on the Learning Hub has not been implemented yet. We're looking for a solution like this official Gatsby example, that uses the existing mdx files and allows for future language-specific mdx files to be added. The future translations will be handed in like this.
Experience Required (Can be done as an individual or as a team)
- Basic JavaScript: React, Gatsby
Milestone Requirements
- I18n solution & add language-selection dropdown in navbar
Software Requirements
- Testing
Other Requirements
- Documentation of the steps taken
Judging Criteria
- Quality of code implementation
Resources
- CryptoDappy Learning Hub repository
- Gatsby - Using I18n → This paradigm should be used as a guide for your implementation in some way
Hi everyone, I'm Ben, technical content marketing manager at Flow - nice to meet you! At Flow, I create technical content and educational material, and I have created CryptoDappy as a starter course to onboard new developers to Flow. You can find me on discord (bebner#2025) - happy to help you wherever I can!
Hi @bebner, this issue has two milestones, am I right?
Hey @hichana, thanks for asking. This issue is a week-long challenge, so there will be only one milestone that combines the above requirements. I edited the issue to reflect that in a better way. Feel free to ping me anytime if you want more information or run into any issues along the way.
Hi @bebner , I'm interested in this issue.
Do you only need to switch the target mdx file according to the selected lang? Or does other hard-coded text in some js files (such as index.js, header.js etc.) also need to be localized?
Hi @knagato,
happy to see you're interested! The task here is indeed twofold: the rendering of the correct mdx files and the localisation for the navigation elements you mentioned. The referenced example of Gatsby shows also how both can be achieved. Cool to see you join FLIP Fest - if you have any questions, do feel free to ping me anytime on Discord (bebner#2025)
Hi @bebner , I'm interested to work on this.
I am experienced with ReactJs but new to gatsby. I can start working if you just point me to some resources.
Hi @bebner , I'm interested in CryptoDappy's i18n, and can translate it into Japanese.
Question: Is it not enough to prepare the translation result for a specific language to be eligible for the prize? I can create a language switching function, but I am concerned that it will duplicate work with other participants.
Hi @karanysingh, cool, happy to have you on board 👋 I think if you have experience in React, Gatsby will be easy for you to master. Their tutorials, especially the quick start, give a good overview of the topic. For this issue, I think the example of using I18n in Gatsby is highly beneficial. Do make sure to sign up on hackerearth and post your team name and github handle on this issue to begin.
Hi @avcdsld, thanks for your interest. The challenge for this buildathon does include the implementation of an I18n solution. However, you can definitely contribute directly on the repository by providing Japanese translations, I think the community would really like that - we already have a Vietnamese version finished, and a Chinese version is in the making. However, for this buildathon you would need to implement the I18n solution.
@bebner Thanks for your reply! I'd like to work on this issue as below:
-- Your team name with a link to the HackerEarth team nagato1_c511 https://www.hackerearth.com/challenges/hackathon/flip-fest/dashboard/c511683/team/
Tag all team members with their Github usernames that are working on the project: @knagato @avcdsld @wshino
When you plan on completing the first milestone. 2021.10.03
Perfect, great to have you on board!
Our team is almost done with the implementation of the translation feature.
Software Requirements Testing
Does this mean we need JavaScript test code? (It seems the original repository doesn't include a testing framework).
Hey @knagato, a basic testing scenario would be great, yes - feel free to fall back on the tool of your choice.
Good day @knagato!
Thanks so much for all your hardwork & participation. In order to finalize winners & prepare for prize payout, we'll need the following actions from your end.
Please provide the following information by Nov 17, 2021, (in this GH Issue is fine):
1. Team Information
- Team Members Information - Github Username + Email Contact + Percentage of prize allocation (total should = 100%)
- All mentioned members MUST react to the post with a 👍 which will act as confirmation that the information is correct, or a 👎 to indicate that the information is not correct.
- We will be reaching out via e-mail
🎖IMPORTANT: We will only proceed with prize payouts once all members have confirmed with 👍 on the post.
2. Video Demo (optional)
- Please provide a 5-minute video demo to be featured & showcased in the FLIP Fest Closing Ceremonies
- Link format & Downloadable (eg. Google Drive, Vimeo)
- Content Format (Problem Statement, your work / how you solved it, final outcome)
We will be hosting Closing Ceremonies on November 23rd, 8AM PT where we'll having closing remarks from Dete & will be announcing the winners! I'll share the details here before Nov 17.
Team Information:
@knagato [email protected] 100% @avcdsld [email protected] 0% @wshino [email protected] 0%
Video Demo: https://drive.google.com/file/d/12JjpZhbMPYrg2MOd9tn85SJ5PPQKl9t8/view?usp=sharing
Hey folks,
We've received and reviewed over 82 submissions! What an amazing community on Flow! To commemorate all the hard work done, we have finalized winners and will be announcing them during our Closing Ceremony on Nov 23rd, 8AM PT. Be sure to join us - there may be some attendance prizes & a keynote from our CTO, Dete 😉!
RSVP here so you don't miss out! See you then!