Skip to content

Commit 1b7746b

Browse files
alinelariguetjhosefmarks
authored andcommitted
feat(readme): melhoria na documentação dos primeiros passos
Fixes: DTHFUI-3020
1 parent f5c3120 commit 1b7746b

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,22 @@ Biblioteca de componentes de UI para Angular.
2121

2222
### Pré-requisitos
2323

24-
Para começar a utilização do PO tenha em mãos o `Node.js` instalado (deve-se utilizar a versão 10.x ou acima) e o seu gerenciador de pacote favorito atualizado. Caso você ainda não tenha instalado o pacote `@angular/cli`, instale-o via `npm` ou `yarn`.
24+
Para começar a utilizar o **Po** (Portinari UI) é pré-requisito ter o `Node.js` instalado (versão 10.x ou acima) e o seu gerenciador de pacote favorito na versão mais atual. Caso você ainda não tenha instalado o pacote `@angular/cli`, instale-o via `npm` ou `yarn`.
2525

2626
Instalando com npm:
2727
```
2828
npm i -g @angular/cli@8.0.0
2929
```
3030

31-
Caso prefira o yarn:
31+
Caso prefira instalar com o yarn:
3232
```
3333
yarn global add @angular/cli@8.0.0
3434
```
3535

3636
### Passo 1 - Crie o seu primeiro projeto
3737

38+
> Caso você já tenha um projeto criado e deseje apenas incluir o **Po**, pule esta etapa e vá para o **Passo 1.1**.
39+
3840
O [Angular CLI](https://cli.angular.io/) se encarrega de construir toda estrutura inicial do projeto. Para isso, execute o seguinte comando:
3941

4042
```
@@ -46,8 +48,9 @@ ng new my-po-project --skipInstall
4648

4749
#### Passo 1.1 - Instalando as dependências
4850

49-
Antes de executar a instalação, é necessário que todas as dependências do projeto estejam declaradas de acordo com a versão
50-
do PO e Angular no arquivo **package.json**, localizado na raiz da aplicação.
51+
Antes de executar a instalação ou inserir o **Po** no seu projeto existente, é necessário verificar as dependências do seu projeto, algumas delas precisam estar de acordo com a versão do **Po** e Angular (elas podem ser encontradas no arquivo `package.json` localizado na raiz da aplicação).
52+
53+
Veja abaixo a lista de dependências e as versões compatíveis, elas devem ser conferidas e se necessário, ajustadas no seu projeto.
5154

5255
```
5356
"dependencies": {
@@ -66,46 +69,58 @@ do PO e Angular no arquivo **package.json**, localizado na raiz da aplicação.
6669
}
6770
```
6871

69-
Após verificar as dependencias, acesse a pasta raiz do seu projeto e execute o comando abaixo:
72+
Após verificar se estas dependências do seu projeto estão com as versões compatíveis declaradas acima, acesse a pasta raiz do seu projeto e execute o comando abaixo:
7073

7174
Instalando com npm:
7275
```
7376
npm install
7477
```
7578

76-
Caso prefira o yarn:
79+
Caso prefira instalar com o yarn:
7780
```
7881
yarn install
7982
```
8083

8184
### Passo 2 - Adiconando o pacote @portinari/portinari-ui
8285

83-
Utilizando o comando `ng add` do [Angular CLI](https://cli.angular.io/), vamos adicionar o PO em seu projeto e o mesmo se encarregará de configurar o tema, instalar o pacote e importar o módulo do PO.
86+
Utilizando o comando `ng add` do [Angular CLI](https://cli.angular.io/), vamos adicionar o **Po** em seu projeto e o mesmo se encarregará de configurar o tema, instalar o pacote e importar o módulo do **Po**.
8487

8588
Execute o comando abaixo na pasta raiz do seu projeto:
8689

8790
```
8891
ng add @portinari/portinari-ui
8992
```
9093

91-
> Ao executar o comando acima, será perguntado se deseja incluir uma estrutura incial em seu projeto, utilizando componentes do PO, caso desejar, apenas informe: `Y`.
94+
> Ao executar o comando acima, será perguntado se deseja incluir uma estrutura inicial em seu projeto com menu lateral, página e toolbar, utilizando componentes do **Po**, **caso desejar, apenas informe: `Y`**.
9295
9396
### Passo 3 - Rode o seu projeto
9497

95-
Agora basta rodar mais um comando para ver seu projeto no ar.
98+
Agora basta executar mais um comando para subir a aplicação e ver o seu projeto rodando no *browser* ;).
9699

97100
```
98101
ng serve
99102
```
100103

101-
Pronto, agora abra seu browser e acesse a url http://localhost:4200 para ver o resultado.
104+
Abra o *browser* e acesse a url http://localhost:4200. Pronto!
102105

103106
----
104107

105108
### E agora?
106109

107110
Agora é só abrir seu **editor / IDE** favorito e começar a trabalhar no seu projeto.
108111

109-
O `@portinari/portinari-ui` por padrão irá configurar uma aplicação com menu lateral, isso já vai ajudar bastante se você está começando a se aventurar no PO e/ou em aplicações Angular.
112+
Caso você queira utilizar nossos componentes de templates, como o **[po-page-login](http://portinari.io/documentation/po-page-login)**, **[po-modal-password-recovery](http://portinari.io/documentation/po-modal-password-recovery)**, **[po-page-blocked-user](http://portinari.io/documentation/po-page-blocked-user)**, **[po-page-dynamic-table](http://portinari.io/documentation/po-page-dynamic-table)** entre outros, basta instalar o pacote `@portinari/portinari-templates` e incluí-lo nas dependências do seu projeto rodando o comando abaixo:
113+
114+
Instalando com npm:
115+
```
116+
npm i --save @portinari/portinari-templates
117+
```
118+
119+
Caso prefira instalar com o yarn:
120+
```
121+
yarn add @portinari/portinari-templates
122+
```
123+
124+
E depois adicionar o `PoTemplatesModule` no módulo principal da sua aplicação :).
110125

111-
A partir daqui você está apto a adicionar outros componentes do **Portinari**.
126+
A partir dai o seu projeto está preparado para receber outros componentes do **[Po](http://portinari.io/documentation)**! \o/

0 commit comments

Comments
 (0)