-
Notifications
You must be signed in to change notification settings - Fork 55
/
README.md
378 lines (229 loc) · 13.8 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<h1 align="center">
<a href="https://laravelcollective.com/tools/banner">
<img alt="Banner" title="#Banner" style="object-fit: cover; height:250px;" src=".github/readmebanner.png" />
</a>
</h1>
# 📝 README-Model
<p align="center"> Uma Breve Descrição: Referêncas, Markdown, Icons para deizar se arquivo README.md muito, mas muito mais legal. </p>
<h2 align="center">
<img src="https://img.shields.io/badge/web%3F-ok-blue?style=for-the-badge" alt="Sistema web Ok" />
<img src="https://img.shields.io/badge/server%3F-ok-blue?style=for-the-badge" alt="Server Ok" />
<img src="https://img.shields.io/badge/Mobile-OK-blue?style=for-the-badge" alt="Aplicativo mobile Ok" />
<img src="https://img.shields.io/badge/License-MIT-blue?color=blue&style=for-the-badge" alt="License" />
</h2>
## 👅 Línguas
- [README in English](README-EN.md)
- [README in German/Deustch](README-DE.md)
- [README in Japanese](README-JA.md)
## 😍 Ícones
- [Ícones](gistfile1.md)
## 📌 Índice
<p align="center">
<a href="#logotipo-ou-banner"> Logotipo ou Banner </a> |
<a href="#nome-do-projeto"> Nome do Projeto </a> |
<a href="#descrição"> Descrição e motivação </a> |
<a href="#index"> Índice </a> |
<a href="#sobre-readme"> Sobre README e MarkDown </a> |
<a href="#badges"> Badges </a> |
<a href="#visuais-e-telas"> Visuais e Telas </a> |
<a href="#tecnologias">Tecnologias </a> |
<a href="#instalação"> Instalação e Funcionalidades </a> |
<a href="#uso"> Uso </a> |
<a href="#status-do-projeto"> Status do projeto </a> |
<a href="#issues"> Issues </a> |
<a href="#contribuições"> Contribuições </a> |
<a href="#autor-e-agradecimentos"> Autores e Agradecimentos </a> |
<a href="#referências"> Referências </a> |
<a href="#licença"> Licença </a>
</p>
## Logotipo ou Banner
Status: Opcional
Se seu projeto já tem uma logo adicione no README. Pode ser um banner também. Você pode criar uma logo ou banner usando o Canva.
A logo ou banner podem substituir o título, mas não a descrição do projeto. O bom de manter o título e descrição em texto é que ajuda no SEO do Github, o Google vai ajudar indexar melhor seu projeto nas primeiras páginas de pesquisas, além de dar um resumo sobre o seu projeto.
## Nome do projeto
Status: Obrigatório
Escolha um nome autoexplicativo e curto para o seu projeto.
## Descrição
Status: Obrigatório
Deixe as pessoas saberem o que seu projeto pode fazer especificamente. Forneça contexto e adicione um link para qualquer referência que os visitantes possam não estar familiarizados. Uma lista de recursos ou uma subseção de plano de fundo também pode ser adicionada aqui. Se houver alternativas ao seu projeto, este é um bom lugar para listar os fatores diferenciadores.
### 🎯 Motivo
Status: Opcional
Descrição do Motivo
------------------------
## ❔ Sobre o README
Cada projeto é diferente, portanto, considere quais dessas seções se aplicam ao seu. As seções usadas no modelo são sugestões para a maioria dos projetos de código aberto. Também tenha em mente que, embora um README possa ser muito longo e detalhado, muito longo é melhor do que muito curto.
Se você acha que seu README é muito longo, considere utilizar outra forma de documentação em vez de cortar as informações. Essa é uma sugestão de estrutura, cada um pode fazer conforme a necessidade do projeto. Vamos agora cobrir cada um dos tópicos da estrutura e outros pontos adicionais.
### ⌨️ O que é Markdown?
O Markdown é uma ferramenta de conversão de texto em HTML. Você escreve usando texto simples de fácil leitura e fácil escrita e depois é transformado em um HTML válido.
Markdown foi criado por John Gruber e Aaron Swartz e seu código fonte foi escrito em Perl. O site oficial é esse [aqui](https://daringfireball.net/projects/markdown/)
[Detalhes](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
É possível visualizar o MarkDown dentro do VS Code adicionando uma extensão:
<h1 align="center">
<img alt="VSCode" title="#VSCode" style="object-fit: cover; height:300px;" src=".github/markdown.png" />
</h1>
| Shortcuts | Functionality |
|:----------|------|
|cmd-k v or ctrl-k| Open preview to the Side|
|cmd-shift-v or ctrl-shift-v | Open preview |
## Badges
Status: Opcional
Em alguns READMEs, você pode ver pequenas imagens que transmitem metadados, como se todos os testes estão passando ou não para o projeto. Você pode usar Shields para adicionar alguns ao seu README. Muitos serviços também possuem instruções para adicionar um crachá.
## 📸 Visuais e Telas
Status: Obrigatório
Dependendo do que você está fazendo, pode ser uma boa ideia incluir capturas de tela ou até mesmo um vídeo (você verá frequentemente GIFs em vez de vídeos reais).
A maneira mais segura de manter os arquivos é criar uma pasta screenshots, github, assets, resources ou nome que você quiser e deixar os arquivos nela. Se você usar um CDN de imagens ou gif pode funcionar mas corre o risco do quebrar o link algum dia.
-------------
### Imagem GIF
<p align="center">
<img src=".github/Readmedemo.gif" alt="GIF" width="700px" />
</p>
## Tecnologias
Status: Obrigatório
| Dia | Descriçao | tecnologias |
|:---:|---------|:-----------:|
| 03/08 |Acelerando sua evolução|   |
| **05/08** |**A escolha da stack**|   |
| **07/08** |**A milha extra**| |
### Funcionalidades
#### Aula 1: Tema
- [x] Criando estrutura da landing page
- [ ] Estilizando landing page
- [ ] Autenticação
- [x] Login / Logout
- [x] Permanecer logado - Token
[Detalhes](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)
## ⚙ Instalação
Status: Obrigatório
Dentro de um determinado ecossistema, pode haver uma maneira comum de instalar coisas, como usar Yarn, NuGet ou Homebrew. No entanto, considere a possibilidade de que quem está lendo seu README seja um novato e gostaria de mais orientação. Listar etapas específicas ajuda a remover ambigüidades e faz com que as pessoas usem seu projeto o mais rápido possível. Se ele for executado apenas em um contexto específico, como uma determinada versão de linguagem de programação ou sistema operacional ou tiver dependências que devem ser instaladas manualmente, adicione também uma subseção Requisitos.
-------------
### Comandos para instalar no MAC
| Tecnologia | Versão | Comando para instalar |
|:----------|------|---------------------|
|NodeJS| 12.18.2| ``` brew install node ``` |
|Yarn | 1.17.3 | ```npm install -g yarn``` |
|Expo | 3.23.1 | ```yarn add global expo-cli```|
## Uso
Use exemplos liberalmente e mostre a saída esperada, se puder. É útil ter embutido o menor exemplo de uso que você pode demonstrar, enquanto fornece links para exemplos mais sofisticados se eles forem muito longos para serem incluídos no README.
-------------
### Characters
----
~~Strikethrough~~ <s>Strikethrough (when enable html tag decode.)</s>
*Italic* _Italic_
**Emphasis** __Emphasis__
***Emphasis Italic*** ___Emphasis Italic___
Superscript: X<sub>2</sub>，Subscript: O<sup>2</sup>
### Code Blocks (Indented style)
### Inline code
`$ npm install marked`
Indented 4 spaces, like `<pre>` (Preformatted Text).
<?php
echo "Hello world!";
?>
Code Blocks (Preformatted text):
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
### HTML code
```html
<!DOCTYPE html>
<html>
<head>
<mate charest="utf-8" />
<title>Hello world!</title>
</head>
<body>
<h1>Hello world!</h1>
</body>
</html>
```
### HTML entities
© & ¨ ™ ¡ £
& < > ¥ € ® ± ¶ § ¦ ¯ « ·
X² Y³ ¾ ¼ × ÷ »
18ºC " '
### Escaping for Special Characters
\*literal asterisks\*
### Clonagem
Primeiro, clone o repositório para seu ambiente:
```bash
> git clone https://github.com/shyoutarou/REPO_NAME.git
```
Depois, entre no repositório clonado e no diretório correspondente ao que quer testar (web, server).
Logo após, insira os seguintes comandos no seu terminal para cada diretório respectivamente:
### 📦 Executar Server API REST
```bash
# Entra no diretório "REPO_NAME"
> cd ./REPO_NAME
# Instala todas as dependências
> yarn install or npm install
```
## Status do projeto
Status: Opcional
Indica se o projeto está em desenvolvimento ou já foi concluído. Se você ficou sem energia ou tempo para o seu projeto, coloque uma nota no topo do README dizendo que o desenvolvimento foi desacelerado ou parou completamente. Alguém pode escolher fazer um fork do seu projeto ou se voluntariar para entrar como mantenedor ou proprietário, permitindo que o projeto continue. Você também pode fazer uma solicitação explícita para mantenedores.
## 🐛 Issues
Status: Opcional
Ofereça às pessoas uma forma de contato. Pode ser qualquer combinação de contatos, uma sala de chat, um endereço de e-mail, etc.
-------------
> Sinta-se à vontade para registrar um novo problema com o respectivo título e descrição no repositório Proffy.
> Se você já encontrou uma solução para seu problema, adoraria revisar sua solicitação de pull!
## 🤝 Contribuições
Status: Obrigatório
Se você tiver ideias para lançamentos no futuro, é uma boa ideia listá-los no README. Indique se você está aberto a contribuições e quais são seus requisitos para aceitá-las.
Para as pessoas que desejam fazer alterações em seu projeto, é útil ter alguma documentação sobre como começar. Talvez haja um script que eles devam executar ou algumas variáveis de ambiente que eles precisem definir. Torne essas etapas explícitas. Essas instruções também podem ser úteis para o seu futuro eu.
Você também pode documentar comandos para lintar o código ou executar testes. Essas etapas ajudam a garantir a alta qualidade do código e a reduzir a probabilidade de que as alterações quebrem algo inadvertidamente. Ter instruções para a execução de testes é especialmente útil se requer configuração externa, como iniciar um servidor Selenium para testar em um navegador.
-------------
Siga os passos abaixo para contribuir:
1. Faça o *fork* do projeto (<https://github.com/shyoutarou/REPO_NAME.git>)
2. Clone o seu *fork* para sua maquína (`git clone https://github.com/user_name/REPO_NAME.git`)
3. Crie uma *branch* para realizar sua modificação (`git checkout -b feature/name_new_feature`)
4. Adicione suas modificações e faça o *commit* (`git commit -m "Descreva sua modificação"`)
5. *Push* (`git push origin feature/name_new_feature`)
6. Crie um novo *Pull Request*
7. Pronto, agora só aguardar a análise
## Autores e reconhecimento
Status: Opcional
Mostre sua gratidão àqueles que contribuíram para o projeto.
-------------
<div align=center>
<table style="width:100%">
<tr align=center>
<th><strong>Eu</strong></th>
</tr>
<tr align=center>
<td>
<a href="https://github.com/shyoutarou">
<img width="200" height="180" style="border-radius: 50%;" src="https://avatars3.githubusercontent.com/u/66930143?s=460&u=9a46318c1563414a627c432d89b8ae53bf359430&v=4">
</a>
</td>
</tr>
</table>
</div>
## ***Referências***
Status: Obrigatório
* Banner
- [Laravel Collective](https://laravelcollective.com/tools/banner)
* MarkDown
- [Editor.md](https://pandao.github.io/editor.md/en.html)
- [Dillinger](https://dillinger.io/)
- [Stackedit](https://stackedit.io/)
- [Devbaraus](https://github.com/devbaraus/markdown-showcase)
* Badges
- [Shields](https://shields.io/)
- [How to Make Custom Badges](https://dev.to/milkers/how-to-make-custom-badges-to-improve-your-markdown-documents-460k)
- [Badger](http://badges.github.io/badgerbadgerbadger/)
* GIFS
- [Recordit](https://recordit.co/)
- [ttystudio](https://github.com/chjj/ttystudio)
* Guias
- [Como fazer um bom README](https://blog.rocketseat.com.br/como-fazer-um-bom-readme/)
- [Make a README](https://www.makeareadme.com/)
- [sampleREADME.md](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)
## 📜 Licença
Status: Obrigatório
Para projetos de código aberto, diga como está licenciado.
-------------
O projeto publicado em 2020 sobre a licença [MIT](./LICENSE) ❤️
Made with ❤️ by Shyoutarou
Gostou? Deixe uma estrelinha para ajudar o projeto ⭐
- [Voltar ao Início](#index)