Skip to content

Commit 8fdbff4

Browse files
FelipenessFelipeness
committed
docs: split README into PT/EN with language toggle badges
1 parent b3217ba commit 8fdbff4

File tree

2 files changed

+88
-79
lines changed

2 files changed

+88
-79
lines changed

‎README.en.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<div align="center">
2+
3+
[![pt-br](https://img.shields.io/badge/lang-Portugu%C3%AAs-green)](README.md)
4+
5+
# Open Source Guide
6+
7+
**Find good first issues in real GitHub projects.**
8+
9+
[**Live demo**](https://felipeness.github.io/opensource-guide/)
10+
11+
</div>
12+
13+
---
14+
15+
### What is it?
16+
17+
A web tool to find issues labeled "good first issue" on GitHub. Filter by language, label, popularity, organization and more — all in real time using the GitHub Search API.
18+
19+
### Features
20+
21+
- **Advanced filters** — language, labels (beginner/intermediate/advanced), stars, date, organization, repository
22+
- **Organization shortcuts** — Microsoft, Meta, Google, Vercel, Apache, Mozilla and more with one click
23+
- **Quality filters** — no assignee, no comments, no linked PR, has description
24+
- **Pagination** — load more results without losing previous ones
25+
- **Synced URL** — all filters are stored in the URL, share searches with others
26+
- **Bilingual** — interface in Portuguese and English
27+
- **Visible rate limit** — track API usage in real time
28+
29+
### Stack
30+
31+
| Technology | Purpose |
32+
|---|---|
33+
| [Next.js 16](https://nextjs.org) | React framework with App Router |
34+
| [TypeScript](https://typescriptlang.org) | Static typing |
35+
| [Tailwind CSS v4](https://tailwindcss.com) | Styling |
36+
| [next-intl](https://next-intl.dev) | Internationalization (PT/EN) |
37+
| [nuqs](https://nuqs.47ng.com) | Filter state synced with URL |
38+
| [Zod](https://zod.dev) | API response validation |
39+
40+
### Running locally
41+
42+
```bash
43+
git clone https://github.com/Felipeness/opensource-guide.git
44+
cd opensource-guide
45+
npm install
46+
npm run dev
47+
```
48+
49+
Open `http://localhost:3000`.
50+
51+
### Increasing the rate limit
52+
53+
Without authentication the GitHub Search API allows 10 searches/min. To increase to 30/min, create a token and configure:
54+
55+
```bash
56+
# .env.local
57+
GITHUB_TOKEN=ghp_your_token_here
58+
```
59+
60+
Generate the token at **GitHub > Settings > Developer Settings > Personal Access Tokens > Fine-grained tokens**. No scopes required.
61+
62+
### Project structure
63+
64+
```
65+
src/
66+
app/
67+
[locale]/ # i18n routes (pt, en)
68+
api/search/ # GitHub API proxy
69+
components/ # Shared components (Hero, Footer, UI)
70+
features/
71+
search/ # Filters, search hook, query builder
72+
issues/ # Cards, grid, states (loading/empty/error)
73+
resources/ # External resource links
74+
tips/ # Contributor tips
75+
i18n/ # PT/EN messages, routing, config
76+
lib/ # Constants, Result type
77+
```
78+
79+
---
80+
81+
## License
82+
83+
[MIT](LICENSE)

‎README.md‎

Lines changed: 5 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
<div align="center">
22

3+
[![en](https://img.shields.io/badge/lang-English-blue)](README.en.md)
4+
35
# Open Source Guide
46

57
**Encontre good first issues em projetos reais do GitHub.**
68

7-
**Find good first issues in real GitHub projects.**
8-
9-
[Portugues](#portugues) | [English](#english)
9+
[**Ver ao vivo**](https://felipeness.github.io/opensource-guide/)
1010

1111
</div>
1212

1313
---
1414

15-
<a id="portugues"></a>
16-
17-
## Portugues
18-
1915
### O que e?
2016

2117
Uma ferramenta web para encontrar issues marcadas como "good first issue" no GitHub. Filtre por linguagem, label, popularidade, organizacao e mais — tudo em tempo real com a GitHub Search API.
@@ -27,7 +23,7 @@ Uma ferramenta web para encontrar issues marcadas como "good first issue" no Git
2723
- **Filtros de qualidade** — sem assignee, sem comentarios, sem PR vinculado, com descricao
2824
- **Paginacao** — carregue mais resultados sem perder os anteriores
2925
- **URL sincronizada** — todos os filtros ficam na URL, compartilhe buscas com outros
30-
- **Bilíngue** — interface em Portugues e Ingles
26+
- **Bilingue** — interface em Portugues e Ingles
3127
- **Rate limit visivel** — acompanhe o uso da API em tempo real
3228

3329
### Stack
@@ -82,76 +78,6 @@ src/
8278

8379
---
8480

85-
<a id="english"></a>
86-
87-
## English
88-
89-
### What is it?
90-
91-
A web tool to find issues labeled "good first issue" on GitHub. Filter by language, label, popularity, organization and more — all in real time using the GitHub Search API.
92-
93-
### Features
94-
95-
- **Advanced filters** — language, labels (beginner/intermediate/advanced), stars, date, organization, repository
96-
- **Organization shortcuts** — Microsoft, Meta, Google, Vercel, Apache, Mozilla and more with one click
97-
- **Quality filters** — no assignee, no comments, no linked PR, has description
98-
- **Pagination** — load more results without losing previous ones
99-
- **Synced URL** — all filters are stored in the URL, share searches with others
100-
- **Bilingual** — interface in Portuguese and English
101-
- **Visible rate limit** — track API usage in real time
102-
103-
### Stack
104-
105-
| Technology | Purpose |
106-
|---|---|
107-
| [Next.js 16](https://nextjs.org) | React framework with App Router |
108-
| [TypeScript](https://typescriptlang.org) | Static typing |
109-
| [Tailwind CSS v4](https://tailwindcss.com) | Styling |
110-
| [next-intl](https://next-intl.dev) | Internationalization (PT/EN) |
111-
| [nuqs](https://nuqs.47ng.com) | Filter state synced with URL |
112-
| [Zod](https://zod.dev) | API response validation |
113-
114-
### Running locally
115-
116-
```bash
117-
git clone https://github.com/Felipeness/opensource-guide.git
118-
cd opensource-guide
119-
npm install
120-
npm run dev
121-
```
122-
123-
Open `http://localhost:3000`.
124-
125-
### Increasing the rate limit
126-
127-
Without authentication the GitHub Search API allows 10 searches/min. To increase to 30/min, create a token and configure:
128-
129-
```bash
130-
# .env.local
131-
GITHUB_TOKEN=ghp_your_token_here
132-
```
133-
134-
Generate the token at **GitHub > Settings > Developer Settings > Personal Access Tokens > Fine-grained tokens**. No scopes required.
135-
136-
### Project structure
137-
138-
```
139-
src/
140-
app/
141-
[locale]/ # i18n routes (pt, en)
142-
api/search/ # GitHub API proxy
143-
components/ # Shared components (Hero, Footer, UI)
144-
features/
145-
search/ # Filters, search hook, query builder
146-
issues/ # Cards, grid, states (loading/empty/error)
147-
resources/ # External resource links
148-
tips/ # Contributor tips
149-
i18n/ # PT/EN messages, routing, config
150-
lib/ # Constants, Result type
151-
```
152-
153-
---
154-
155-
## License
81+
## Licenca
15682

15783
[MIT](LICENSE)

0 commit comments

Comments
 (0)