readme_template

Índice

• Overview
• Links
  • Badges
  • Shields
  • Mark Down Demo
• Templates
  • Linguagem
  • Tabela
  • Flow Chart
  • Diagrama
  • Projetos
    • Nome do Projeto
    • Descrição do Projeto
      • Features
    • Estrutura de Pastas
    • Aprendizado
    • Desafios
    • Construção
    • Tecnologias
• Autor

Overview

Esse repositório foi feito para manter meu template de Readme para projetos e também para guardar alguns links que eu achei interessante de se ter

Links

Badges

Encontra-se nesse repositório do github Badges

Shields

shields.io

https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>&style=<STYLE>&logo=<LOGO>

1. LABEL: texto do campo esquerdo
2. MESSAGE: texto do campo direto
3. COLOR: cor do campo direito, pode usar RGB.
4. STYLE: estilo do badge inteiro. Podemos ter: plastic, flat, for-the-badge, social ou flat-square. Teste cada uma delas.
5. LOGO: logo do campo esquerdo

MD Demo

Mark Down Demo

Templates

Linguagem

• bash

npm install 

• javascript

let code = 'clean';

Notas

Note: This is a Note. There is no content here, sorry ~

Tabela

coluna1	coluna 2
item 1	item 2

coluna 1	coluna 2	coluna 3
item 1	item 2	item 3
item 4	item 5	item 6

Flow Chart

graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D

Loading

Diagrama

sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

Bob-->Alice: Checking with John...
Alice->John: Yes... John, how are you?

Loading

Projetos

Nome do Projeto

📝Descrição

⚙Features

• Feature 01
• Cadastro de cliente
• Cadastro de produtos

📂Estrutura de Pastas

VSCode File tree generator

Exemplo do projeto Clipz (com ícones)

Ver estrutura

📦src
 ┣ 📂app
 ┃ ┣ 📂about
 ┃ ┃ ┣ 📜about.component.html
 ┃ ┃ ┣ 📜about.component.scss
 ┃ ┃ ┣ 📜about.component.spec.ts
 ┃ ┃ ┗ 📜about.component.ts
 ┃ ┣ 📂clip
 ┃ ┃ ┣ 📜clip.component.html
 ┃ ┃ ┣ 📜clip.component.scss
 ┃ ┃ ┣ 📜clip.component.spec.ts
 ┃ ┃ ┗ 📜clip.component.ts
 ┃ ┣ 📂clips-list
 ┃ ┃ ┣ 📜clips-list.component.html
 ┃ ┃ ┣ 📜clips-list.component.scss
 ┃ ┃ ┣ 📜clips-list.component.spec.ts
 ┃ ┃ ┗ 📜clips-list.component.ts
 ┃ ┣ 📂home
 ┃ ┃ ┣ 📜home.component.html
 ┃ ┃ ┣ 📜home.component.scss
 ┃ ┃ ┣ 📜home.component.spec.ts
 ┃ ┃ ┗ 📜home.component.ts
 ┃ ┣ 📂models
 ┃ ┃ ┣ 📜clip.model.ts
 ┃ ┃ ┗ 📜user.model.ts
 ┃ ┣ 📂nav
 ┃ ┃ ┣ 📜nav.component.html
 ┃ ┃ ┣ 📜nav.component.scss
 ┃ ┃ ┣ 📜nav.component.spec.ts
 ┃ ┃ ┗ 📜nav.component.ts
 ┃ ┣ 📂not-found
 ┃ ┃ ┣ 📜not-found.component.html
 ┃ ┃ ┣ 📜not-found.component.scss
 ┃ ┃ ┣ 📜not-found.component.spec.ts
 ┃ ┃ ┗ 📜not-found.component.ts
 ┃ ┣ 📂pipes
 ┃ ┃ ┣ 📜fb-timestamp.pipe.spec.ts
 ┃ ┃ ┗ 📜fb-timestamp.pipe.ts
 ┃ ┣ 📂services
 ┃ ┃ ┣ 📜auth.service.spec.ts
 ┃ ┃ ┣ 📜auth.service.ts
 ┃ ┃ ┣ 📜clip.service.spec.ts
 ┃ ┃ ┣ 📜clip.service.ts
 ┃ ┃ ┣ 📜ffmpeg.service.spec.ts
 ┃ ┃ ┣ 📜ffmpeg.service.ts
 ┃ ┃ ┣ 📜modal.service.spec.ts
 ┃ ┃ ┗ 📜modal.service.ts
 ┃ ┣ 📂shared
 ┃ ┃ ┣ 📂alert
 ┃ ┃ ┃ ┣ 📜alert.component.html
 ┃ ┃ ┃ ┣ 📜alert.component.scss
 ┃ ┃ ┃ ┣ 📜alert.component.spec.ts
 ┃ ┃ ┃ ┗ 📜alert.component.ts
 ┃ ┃ ┣ 📂directives
 ┃ ┃ ┃ ┣ 📜event-blocker.directive.spec.ts
 ┃ ┃ ┃ ┗ 📜event-blocker.directive.ts
 ┃ ┃ ┣ 📂input
 ┃ ┃ ┃ ┣ 📜input.component.html
 ┃ ┃ ┃ ┣ 📜input.component.scss
 ┃ ┃ ┃ ┣ 📜input.component.spec.ts
 ┃ ┃ ┃ ┗ 📜input.component.ts
 ┃ ┃ ┣ 📂modal
 ┃ ┃ ┃ ┣ 📜modal.component.html
 ┃ ┃ ┃ ┣ 📜modal.component.scss
 ┃ ┃ ┃ ┣ 📜modal.component.spec.ts
 ┃ ┃ ┃ ┗ 📜modal.component.ts
 ┃ ┃ ┣ 📂tab
 ┃ ┃ ┃ ┣ 📜tab.component.html
 ┃ ┃ ┃ ┣ 📜tab.component.scss
 ┃ ┃ ┃ ┣ 📜tab.component.spec.ts
 ┃ ┃ ┃ ┗ 📜tab.component.ts
 ┃ ┃ ┣ 📂tabs-container
 ┃ ┃ ┃ ┣ 📜tabs-container.component.html
 ┃ ┃ ┃ ┣ 📜tabs-container.component.scss
 ┃ ┃ ┃ ┣ 📜tabs-container.component.spec.ts
 ┃ ┃ ┃ ┗ 📜tabs-container.component.ts
 ┃ ┃ ┗ 📜shared.module.ts
 ┃ ┣ 📂user
 ┃ ┃ ┣ 📂auth-modal
 ┃ ┃ ┃ ┣ 📜auth-modal.component.html
 ┃ ┃ ┃ ┣ 📜auth-modal.component.scss
 ┃ ┃ ┃ ┣ 📜auth-modal.component.spec.ts
 ┃ ┃ ┃ ┗ 📜auth-modal.component.ts
 ┃ ┃ ┣ 📂login
 ┃ ┃ ┃ ┣ 📜login.component.html
 ┃ ┃ ┃ ┣ 📜login.component.scss
 ┃ ┃ ┃ ┣ 📜login.component.spec.ts
 ┃ ┃ ┃ ┗ 📜login.component.ts
 ┃ ┃ ┣ 📂register
 ┃ ┃ ┃ ┣ 📜register.component.html
 ┃ ┃ ┃ ┣ 📜register.component.scss
 ┃ ┃ ┃ ┣ 📜register.component.spec.ts
 ┃ ┃ ┃ ┗ 📜register.component.ts
 ┃ ┃ ┣ 📂validators
 ┃ ┃ ┃ ┣ 📜email-taken.spec.ts
 ┃ ┃ ┃ ┣ 📜email-taken.ts
 ┃ ┃ ┃ ┣ 📜register-validators.spec.ts
 ┃ ┃ ┃ ┗ 📜register-validators.ts
 ┃ ┃ ┗ 📜user.module.ts
 ┃ ┣ 📂video
 ┃ ┃ ┣ 📂edit
 ┃ ┃ ┃ ┣ 📜edit.component.html
 ┃ ┃ ┃ ┣ 📜edit.component.scss
 ┃ ┃ ┃ ┣ 📜edit.component.spec.ts
 ┃ ┃ ┃ ┗ 📜edit.component.ts
 ┃ ┃ ┣ 📂manage
 ┃ ┃ ┃ ┣ 📜manage.component.html
 ┃ ┃ ┃ ┣ 📜manage.component.scss
 ┃ ┃ ┃ ┣ 📜manage.component.spec.ts
 ┃ ┃ ┃ ┗ 📜manage.component.ts
 ┃ ┃ ┣ 📂pipes
 ┃ ┃ ┃ ┣ 📜safe-url.pipe.spec.ts
 ┃ ┃ ┃ ┗ 📜safe-url.pipe.ts
 ┃ ┃ ┣ 📂upload
 ┃ ┃ ┃ ┣ 📜upload.component.html
 ┃ ┃ ┃ ┣ 📜upload.component.scss
 ┃ ┃ ┃ ┣ 📜upload.component.spec.ts
 ┃ ┃ ┃ ┗ 📜upload.component.ts
 ┃ ┃ ┣ 📜video-routing.module.ts
 ┃ ┃ ┗ 📜video.module.ts
 ┃ ┣ 📜app-routing.module.ts
 ┃ ┣ 📜app.component.html
 ┃ ┣ 📜app.component.scss
 ┃ ┣ 📜app.component.spec.ts
 ┃ ┣ 📜app.component.ts
 ┃ ┗ 📜app.module.ts
 ┣ 📂assets
 ┃ ┣ 📂img
 ┃ ┃ ┗ 📜author_img.jpg
 ┃ ┣ 📂video
 ┃ ┃ ┗ 📜hero.webm
 ┃ ┗ 📜.gitkeep
 ┣ 📂environments
 ┃ ┣ 📜environment.prod.ts
 ┃ ┗ 📜environment.ts
 ┣ 📜favicon.ico
 ┣ 📜index.html
 ┣ 📜main.ts
 ┣ 📜polyfills.ts
 ┣ 📜styles.scss
 ┗ 📜test.ts

📚Aprendizado

🚀Desafios

🚧Construção

⚡Tecnologias

😄Autor

Rafael Lima