58
58
Goxygen visa poupar seu tempo ao montar um novo projeto. Ele
59
59
cria o esqueleto de uma aplicação com todas as configurações
60
60
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,
62
62
conecta ele com os componentes front end, fornece o Dockerfile
63
63
para a aplicação e cria o arquivo docker-compose para rapidamente
64
64
executar em ambientes de desenvolvimento e produção.
65
65
66
66
<table >
67
67
<thead>
68
68
<tr align="center">
69
- <td colspan=4><b>Supported Technologies </b></td>
69
+ <td colspan=4><b>Tecnologias suportadas </b></td>
70
70
</tr>
71
71
</thead>
72
72
<tbody>
@@ -89,92 +89,111 @@ executar em ambientes de desenvolvimento e produção.
89
89
</tbody>
90
90
</table >
91
91
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.
94
94
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 ` .
98
108
```
99
109
export GO111MODULE=auto
100
110
```
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
+ ```
101
116
102
- ## Como utilizar
117
+ ### Go 1.11 - 1.15
118
+
119
+ Rode os comandos
103
120
``` go
104
121
go get -u github.com /shpota/goxygen
105
122
go run github.com /shpota/goxygen init my-app
106
123
```
124
+ </details >
125
+
107
126
Isso gera um projeto no diretório ` my-app ` .
108
127
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:
113
132
114
133
``` go
115
134
go run github.com /shpota/goxygen init --frontend vue --db postgres my-app
116
135
```
117
136
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 ` .
120
139
121
140
O projeto gerado está pronto para ser executado com ` docker-compose ` :
122
141
``` sh
123
142
cd my-app
124
143
docker-compose up
125
144
```
126
145
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
128
147
http://localhost:8080 .
129
148
130
- Você pode encontrar mais detalhes de como trabalhar com o projeto
149
+ Você pode encontrar mais detalhes de como utilizar o projeto
131
150
gerado em seu arquivo README.
132
151
133
152
![ Showcase] ( showcase.gif )
134
153
135
- ## Estrutura do projeto gerado (React/MongoDB example )
154
+ ## Estrutura do projeto gerado (Exemplo com React/MongoDB)
136
155
137
156
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
144
163
├── webapp
145
164
│ ├── public # ícones, arquivos estáticos e index.html
146
165
│ ├── src
147
166
│ │ ├── App.js # O principal componente React
148
167
│ │ ├── App.css # Estilização do componente App
149
168
│ │ ├── index.js # Ponto de entrada da aplicação
150
- │ │ └── index.css # global styles
169
+ │ │ └── index.css # Estilos globais
151
170
│ ├── package.json # dependências do front end
152
171
│ ├── .env.development # API endpoint para ambiente de desenvolvimento
153
172
│ └── .env.production # API endpoint para ambiente de produção
154
173
├── 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
156
175
├── docker-compose-dev.yml # executa um MongoDB local para fins de desenvolvimento
157
176
├── init-db.js # cria um MongoDB collection com dados de teste
158
177
├── .dockerignore # especifica arquivos ignorados no Docker build
159
178
├── .gitignore
160
179
└── README.md # guia sobre como usar o repositório gerado
161
180
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.
164
183
165
184
## Dependências
166
185
167
186
Goxygen gera uma estrutura básica de um projeto e não o força usar um
168
187
conjunto específico de ferramentas. E por isso não traz dependências
169
188
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
171
190
e [ axios] ( https://github.com/axios/axios ) nos projetos React e Vue.
172
191
Projetos Angular usam apenas bibliotecas específicas do Angular.
173
192
174
193
## Como contribuir
175
194
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 )
178
197
e nós iremos consertar o mais rápido possível. Você também pode enviar
179
198
suas alterações via Pull Request. Dê um fork no repositório, faça
180
199
alterações, nos envie um pull request que nós iremos analisar em breve.
0 commit comments