Write a tutorial using LinguiJS with React

This is a HactoberFest issue! Read the contest details for more info.

Before you begin

• Confirm that you’re working on this issue so I can add 👩‍💻assigned label.
• Use next branch as a base for your PR. This feature should be released in upcoming v3.
• Read the contribution guide for info how to setup project, run tests and use development version of packages
• Join us on gitter to get support

Starting point

• Use the existing tutorial to learn about LinguiJS
• Use create-react-app to bootstrap example project. You should use create-react-app v2.
• Install @lingui/react and add @lingui/cli @lingui/macro as development dependencies

Content

• You might use existing tutorial as a starting point but feel free to provide your own example.
• (optional) The challenge is that existing tutorial is written for LinguiJS v2, but the new tutorial should be for v3. If you feel ambitious, checkout migration guide for the list of changes. Otherwise, feel free to write the tutorial for LinguiJS v2 and I’ll rewrite examples afterwards. No big deal at all!
• (optional) Don’t worry about formatting! The documentation uses reStructuredText. It’s very similar to Markdown. If you find it confusing, focus on content and I’ll fix the markup once it’s finished.
• The tutorial should cover following topics:
  • Installation
  • Project setup (i18n manager, I18nProvider)
  • Trans component for messages, including how to use variables and inline tags
  • Translation of props using i18n manager (accessed through I18n render prop component or withI18n hoc)
  • Pluralization using Plural
  • Date/Number formatting using DateFormat and NumberFormat
  • Working with CLI (adding locales, extracting, compiling)
  • Loading catalogs into app (either directly or using @lingui/loader webpack loader)

Additional requirements

It might be beneficial if you have some experience with react-intl or any internationalization library. I believe for the best result you shouldn’t be too much familiar with LinguiJS. The tutorial should be for the first time users and for that reason it’s hard for me to write it.

This is a very long task, so it might take several hours to finish it. Feel free to reach me at gitter anytime.

[tricoder42]

I’ve just realized that writing the tutorial for v3 might be much easier that I thought. There’s already an example project. It doesn’t use create-react-app, but all new features from upcoming v3. All examples are basically in the main App.js file. The v3 prerelease is already published on NPM under next tag (npm install @lingui/cli@next, etc). Might be worth taking a look, because v3 fixes a lot of issues with CRA.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.