Skip to content

Commit a147aab

Browse files
chore: Create Hacktobefest2024 (tolgee#2493)
Co-authored-by: Jan Cizmar <[email protected]>
1 parent b9836bb commit a147aab

35 files changed

+6168
-2
lines changed

Hacktobefest2024.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Welcome to Hacktoberfest 2024 with Tolgee
2+
3+
Join the community this Hacktoberfest by contributing to Tolgee!
4+
5+
![Hacktobefest 2024](https://github.com/user-attachments/assets/ac1bd9c1-fc1f-4375-9bf5-8e8c9b41cc15)
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.

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,44 @@ An open-source alternative to Crowdin, Phrase or Lokalise
2828
[<img src="https://img.shields.io/badge/-Facebook-424549?style=social&logo=facebook" height=25 />](https://www.facebook.com/Tolgee.i18n)
2929
[<img src="https://img.shields.io/badge/-Twitter-424549?style=social&logo=twitter" height=25 />](https://twitter.com/Tolgee_i18n)
3030
[<img src="https://img.shields.io/badge/-Linkedin-424549?style=social&logo=linkedin" height=25 />](https://www.linkedin.com/company/tolgee)
31+
</div>
3132

33+
[![Hacktobefest 2024](https://github.com/user-attachments/assets/c25ea58a-4bcf-4cd1-8fb6-e418466a57cf)](./Hacktobefest2024.md)
3234

35+
We are sending swags for awesome demos merged PRs! For complete information, check
36+
our [Hacktobefest2024.md](./Hacktobefest2024.md)
3337

34-
**Become part of the family. Join [slack channel <img src="https://img.shields.io/badge/-Tolgee Comunity-424549?style=social&logo=slack" height=25 />](https://join.slack.com/t/tolgeecommunity/shared_invite/zt-195isb5u8-_RcSRgVJfvgsPpOBIok~IQ)**
38+
### Submission Types
39+
- **Pull Requests**: Submit a pull request addressing issues tagged with #hacktoberfest
40+
- You can **create a demo** with any of the following frameworks: React, Angular, Vue, Svelte, PHP, Flutter, Ruby, iOS, Android
3541

36-
</div>
42+
### Quality Criteria
43+
44+
Your submissions will be evaluated based on the following criteria, with each project receiving a score between 10-50 points:
45+
- **Quality**: Is the code well-written, tested, and maintainable
46+
- **User Experience (UX)**: How intuitive and user-friendly is the implementation?
47+
- **Creativity**: Does the project offer a unique approach or innovative features?
48+
- **Usefulness**: How valuable is the contribution to the users?
49+
50+
According to the points, you'll get an amount of swag:
51+
52+
- 30 - 40 points - Tolgee Sticker set
53+
- 40 - 45 points - Tolgee Sticker set + Tolgee Socks
54+
- 45 - 50 points - Tolgee Sticker set + Tolgee Socks + Tolgee T-shirt
55+
56+
### Repository Star ⭐
3757

58+
Please start the [Tolgee repository](https://github.com/tolgee/tolgee-platform) as part of your contribution!
59+
60+
For complete information, check our [Hacktobefest2024.md](./Hacktobefest2024.md)
61+
62+
Join Tolgee Community [Tolgee Slack Community <img src="https://img.shields.io/badge/-Tolgee Comunity-424549?style=social&logo=slack" height=25 />](https://join.slack.com/t/tolgeecommunity/shared_invite/zt-195isb5u8-_RcSRgVJfvgsPpOBIok~IQ) to share your ideas, suggestions, or questions and connect with other users and contributors.
3863

3964
![Tolgee](https://user-images.githubusercontent.com/18496315/188632536-3547fd70-755c-4a32-9b1e-fb1afbf84b33.png)
4065

4166
## Quick links
4267
- [Tolgee Website](https://tolgee.io)
68+
4369
- Product (Learn more about the great features)
4470
- [Dev tools](https://tolgee.io/features/dev-tools)
4571
- [Translation assistance](https://tolgee.io/features/translation-assistance)

demos/react-demo-example/.env

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
VITE_APP_TOLGEE_API_URL=https://app.tolgee.io
2+
VITE_APP_TOLGEE_API_KEY=

demos/react-demo-example/.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

0 commit comments

Comments
 (0)