Skip to content

Commit f3b8c36

Browse files
authored
Update Portuguese version of docs (#137)
1 parent 147c621 commit f3b8c36

File tree

1 file changed

+49
-30
lines changed

1 file changed

+49
-30
lines changed

.github/README_pt-br.md

+49-30
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,15 @@
5858
Goxygen visa poupar seu tempo ao montar um novo projeto. Ele
5959
cria o esqueleto de uma aplicação com todas as configurações
6060
prontas para você. Você pode começar a implementar sua lógica
61-
de negócios imediatamente. Goxygen gera o código back end Go,
61+
de negócios imediatamente. Goxygen gera o código back end em Go,
6262
conecta ele com os componentes front end, fornece o Dockerfile
6363
para a aplicação e cria o arquivo docker-compose para rapidamente
6464
executar em ambientes de desenvolvimento e produção.
6565

6666
<table>
6767
<thead>
6868
<tr align="center">
69-
<td colspan=4><b>Supported Technologies</b></td>
69+
<td colspan=4><b>Tecnologias suportadas</b></td>
7070
</tr>
7171
</thead>
7272
<tbody>
@@ -89,92 +89,111 @@ executar em ambientes de desenvolvimento e produção.
8989
</tbody>
9090
</table>
9191

92-
## Requirements
93-
Você precisa ter Go 1.11 ou mais recente na sua máquina.
92+
## Requisitos
93+
Você precisa de Go 1.11 ou mais recente na sua máquina.
9494

95-
The `GO111MODULE` environment variable has to be set to `auto`
96-
for the generation logic to work. It is a default for Go
97-
versions up to 1.15. For Go 1.16, you need to set it explicitly:
95+
## Como utilizar
96+
97+
Go 1.17 e posterior:
98+
```go
99+
go run github.com/shpota/goxygen@latest init my-app
100+
```
101+
102+
<details>
103+
<summary>Versões anteriores de Go</summary>
104+
105+
### Go 1.16
106+
107+
Configure a variável de ambiente `GO111MODULE` como `auto`.
98108
```
99109
export GO111MODULE=auto
100110
```
111+
Rode os comandos
112+
```go
113+
go get -u github.com/shpota/goxygen
114+
go run github.com/shpota/goxygen init my-app
115+
```
101116

102-
## Como utilizar
117+
### Go 1.11 - 1.15
118+
119+
Rode os comandos
103120
```go
104121
go get -u github.com/shpota/goxygen
105122
go run github.com/shpota/goxygen init my-app
106123
```
124+
</details>
125+
107126
Isso gera um projeto no diretório `my-app`.
108127

109-
By default, it will use React and MongoDB. You can select
110-
a different front end framework and a database using
111-
`--frontend` and `--db` flags. For instance, this command
112-
will create a project with Vue and PostgreSQL:
128+
Por padrão, será usado React e MongoDB. Você pode selecionar
129+
um framework de front end e um banco de dados diferentes usando
130+
os argumentos `--frontend` e `--db`. Por exemplo, este comando
131+
criará um projeto usando Vue e PostgreSQL:
113132

114133
```go
115134
go run github.com/shpota/goxygen init --frontend vue --db postgres my-app
116135
```
117136

118-
The `--frontend` flag accepts `angular`, `react` and `vue`.
119-
The `--db` flag accepts `mongo`, `mysql` and `postgres`.
137+
O argumento `--frontend` aceita as opções `angular`, `react` e `vue`.
138+
O argumento `--db` aceita as opções `mongo`, `mysql` e `postgres`.
120139

121140
O projeto gerado está pronto para ser executado com `docker-compose`:
122141
```sh
123142
cd my-app
124143
docker-compose up
125144
```
126145

127-
Após o build ser concluído, a aplicação está disponível em
146+
Após o build ser concluído, a aplicação ficará disponível em
128147
http://localhost:8080.
129148

130-
Você pode encontrar mais detalhes de como trabalhar com o projeto
149+
Você pode encontrar mais detalhes de como utilizar o projeto
131150
gerado em seu arquivo README.
132151

133152
![Showcase](showcase.gif)
134153

135-
## Estrutura do projeto gerado (React/MongoDB example)
154+
## Estrutura do projeto gerado (Exemplo com React/MongoDB)
136155

137156
my-app
138-
├── server # Go project files
139-
│ ├── db # MongoDB communications
140-
│ ├── model # domain objects
141-
│ ├── web # REST APIs, web server
142-
│ ├── server.go # O ponto inicial do server
143-
│ └── go.mod # dependências do server
157+
├── server # Arquivos do projeto Go
158+
│ ├── db # Comunicação com o MongoDB
159+
│ ├── model # Objetos de domínio
160+
│ ├── web # REST APIs, servidor web
161+
│ ├── server.go # O ponto de acesso do servidor
162+
│ └── go.mod # dependências do servidor
144163
├── webapp
145164
│ ├── public # ícones, arquivos estáticos e index.html
146165
│ ├── src
147166
│ │ ├── App.js # O principal componente React
148167
│ │ ├── App.css # Estilização do componente App
149168
│ │ ├── index.js # Ponto de entrada da aplicação
150-
│ │ └── index.css # global styles
169+
│ │ └── index.css # Estilos globais
151170
│ ├── package.json # dependências do front end
152171
│ ├── .env.development # API endpoint para ambiente de desenvolvimento
153172
│ └── .env.production # API endpoint para ambiente de produção
154173
├── Dockerfile # faz o build do back end e o front end juntos
155-
├── docker-compose.yml # deploy em abiente de produção
174+
├── docker-compose.yml # deploy em ambiente de produção
156175
├── docker-compose-dev.yml # executa um MongoDB local para fins de desenvolvimento
157176
├── init-db.js # cria um MongoDB collection com dados de teste
158177
├── .dockerignore # especifica arquivos ignorados no Docker build
159178
├── .gitignore
160179
└── README.md # guia sobre como usar o repositório gerado
161180

162-
Arquivos como testes de unidade ou sample components não estão incluídos
163-
aqui pela simplicidade.
181+
Arquivos como testes unitários ou componentes de exemplo não estão incluídos
182+
aqui para fins de simplicidade.
164183

165184
## Dependências
166185

167186
Goxygen gera uma estrutura básica de um projeto e não o força usar um
168187
conjunto específico de ferramentas. E por isso não traz dependências
169188
desnecessárias para o seu projeto. Ele usa apenas
170-
database driver no back end
189+
um driver de banco de dados no back end
171190
e [axios](https://github.com/axios/axios) nos projetos React e Vue.
172191
Projetos Angular usam apenas bibliotecas específicas do Angular.
173192

174193
## Como contribuir
175194

176-
Se você encontrou um bug ou tem alguma idéia de como melhorar o projeto,
177-
[abra uma issue](https://github.com/Shpota/goxygen/issues)
195+
Se você encontrou um bug ou tem alguma ideia de como melhorar o projeto,
196+
[abra um issue](https://github.com/Shpota/goxygen/issues)
178197
e nós iremos consertar o mais rápido possível. Você também pode enviar
179198
suas alterações via Pull Request. Dê um fork no repositório, faça
180199
alterações, nos envie um pull request que nós iremos analisar em breve.

0 commit comments

Comments
 (0)