|
| 1 | +# Welcome to Hacktoberfest 2024 with Tolgee |
| 2 | + |
| 3 | +Join the community this Hacktoberfest by contributing to Tolgee! |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +You have the opportunity to make a difference by submitting pull requests to the Tolgee repository with the **#hacktoberfest** tag or by creating and showcasing a demo of your work. As a token of our appreciation, you can receive exclusive Tolgee swag, including stickers, socks, and T-shirts, along with a Digital Reward Kit from Hacktoberfest! |
| 8 | + |
| 9 | +### What is Tolgee? 🐁 |
| 10 | + |
| 11 | +Tolgee is an open-source localization platform that makes it **easy for developers to create multilingual apps**. With Tolgee, you can seamlessly integrate translation capabilities into your projects, enabling you to reach a global audience effortlessly. |
| 12 | + |
| 13 | +### Key Features |
| 14 | + |
| 15 | +- Native SDKs for Vanilla JS, React frameworks, Angular, VueJS frameworks, Svelte, React Native, Unreal engine enabling you to in-context translate the string directly in your App |
| 16 | +- Supported formats: JSON, XLIFF, PO PHP, PO C/C++, PO Python, Apple Strings, Apple Stringsdict, Apple XLIFF, Android XML, Flutter ARB, Ruby YAML |
| 17 | +- Tolgee Contextual AI translation: ChatGPT powered translation uses the context gathered by the Native SDKs for Web to provide the best possible results |
| 18 | +- Option to connect other translators like Google Translate or DeepL to easily translate words in the dashboard |
| 19 | +- Translation memory |
| 20 | +- Opt in Automatic translation: After adding the key your string is automatically translated |
| 21 | +- Publish to CDN and S3 to get your translation data to production |
| 22 | +- CLI may be used to push/pull new data in all supported formats |
| 23 | + |
| 24 | +## How to Get Started? |
| 25 | + |
| 26 | +Getting started with Tolgee is easy! You have two options to integrate it into your projects: |
| 27 | + |
| 28 | +1. **Self-Host Tolgee** |
| 29 | + - You can deploy Tolgee on your own server for complete control and customization. Simply follow our [installation guide](https://tolgee.io/platform/self_hosting/getting_started) to set up the platform locally or on your preferred cloud provider. |
| 30 | + - You can follow the [development wiki](https://github.com/tolgee/tolgee-platform/wiki/Development) to start the tolgee-platform locally in development mode. |
| 31 | +2. **Use Tolgee Cloud**: If you prefer a hassle-free experience, you can use [Tolgee Cloud](https://app.tolgee.io/). This option allows you to access all of Tolgee's features without the need for server management. |
| 32 | + |
| 33 | +## How to Earn Tolgee Swag? |
| 34 | + |
| 35 | +To ensure that contributions are recognized and rewarded fairly, we’ve established the following rules for earning swag: |
| 36 | + |
| 37 | +1. **Submission Types**: |
| 38 | + - **Pull Requests**: Submit a pull request addressing issues tagged with #hacktoberfest tag |
| 39 | + - **Demo Projects**: |
| 40 | + - Create a demo showcasing your contribution or use of Tolgee |
| 41 | + - React App using Tolgee |
| 42 | + - Angular App using Tolgee |
| 43 | + - Vue App using Tolgee |
| 44 | + - Svelte App using Tolgee |
| 45 | + - PHP App |
| 46 | + - Flutter App (Native SDK) |
| 47 | + - Flutter App (Build in localization) |
| 48 | + - Ruby App |
| 49 | + - iOS app |
| 50 | + - Android App |
| 51 | + - Submit the demo into the [`/demos`](./demos) folder in the repository |
| 52 | + - There is an example of [React app in the folder](./demos/react-demo-example) |
| 53 | + - It has to be different from the official examples we have published in [Tolgee JS repository](https://github.com/tolgee/tolgee-js/tree/main/testapps) |
| 54 | + - For React, Angular, Vue and Svelte, we prefer using [Tolgee Native SDKs](https://tolgee.io/js-sdk) |
| 55 | + - For other technologies, you can use [Tolgee CLI](https://tolgee.io/tolgee-cli) to push and pull strings |
| 56 | + |
| 57 | +2. **Quality Criteria** |
| 58 | + Your submissions will be evaluated based on the following criteria, with each project receiving a score between 10-50 points: |
| 59 | + - **Quality**: Is the code well-written, tested, and maintainable? |
| 60 | + - **User Experience (UX)**: How intuitive and user-friendly is the implementation? |
| 61 | + - **Creativity**: Does the project offer a unique approach or innovative features? |
| 62 | + - **Usefulness**: How valuable is the contribution to the users? |
| 63 | + |
| 64 | + According to the points, you'll get this amount of swag |
| 65 | + - 30 - 40 points - Tolgee Sticker set |
| 66 | + - 40 - 45 points - Tolgee Sticker set + Tolgee Socks |
| 67 | + - 45 - 50 points - Tolgee Sticker set + Tolgee Socks + Tolgee T-shirt |
| 68 | + |
| 69 | +4. **Demo Template** |
| 70 | + |
| 71 | +If you’re creating a demo, please include: |
| 72 | + - A brief description of your project |
| 73 | + - A screenshot or video demonstration |
| 74 | + - A link to a DEV.to (or your own blog) article about your demo |
| 75 | + |
| 76 | +5. **Repository Star** ⭐ |
| 77 | + |
| 78 | +Please make sure to star the Tolgee repository https://github.com/tolgee/tolgee-platform as part of your contribution! |
| 79 | + |
| 80 | +## Tolgee Community |
| 81 | + |
| 82 | +Join [Tolgee Slack Community](https://tolgeecommunity.slack.com/ssb/redirect) to share your ideas, suggestions, or questions and connect with other users and contributors. |
0 commit comments