Nesta aula começaremos a criar o projeto da nossa loja, a API Restful que vamos construir com NestJS.
Na documentação encontraremos dicas de como criar um projeto com NestJS.
O NestJS tem uma linha de comando que cria e configura todas as dependências que ele precisa para funcionar e faz isso de forma automática. Basta executarmos um comando e ele cria o package.json, baixa as dependências e deixa o projeto completamente configurado para nós começarmos a escrita do código.
Estes são os comandos informados na documentação paras instalação e criação de novo projeto:
$ npm i -g @nestjs/cli
$ nest new project-name
Poderíamos usar o comando npm i -g @nestjs/cli para instalar a linha de comando na ferramenta, para conseguir criar projetos com o NestJS. E depois, para criar um projeto, poderíamos usar nest new project-name.
Mas eu, pessoalmente, não gosto muito de instalar ferramentas de linhas de comando de frameworks de forma grupal, até porque se tivermos projetos usando esse mesmo framework com pessoas diferentes pode ter algum problema.
Então, faremos de um jeito um pouco diferente, mas fique à vontade para fazer como a documentação indica, se você preferir.
Vamos abrir o terminal, já estou na pasta com meu usuário, C: \_alura-users\Wanderson Macedo. Agora vamos digitar o comando para o NestJS criar o projeto.
Diferente do que está na documentação, vamos digitar npx @nestjs/cli e passaremos o comando para criar o projeto que será nomeado como "loja".
Após pressionarmos "Enter" o NPX vai perguntar se queremos instalar o pacote do CLI, vamos responder que sim. E vamos esperar a CLI criar o projeto. Vai criar a parte de loja, o package.json, vai instalar todas as dependências que o NestJS precisa para funcionar.
Ele exibe uma lista com os arquivos criados e pergunta qual gerenciador de pacotes queremos usar no projeto e dá três opções: npm, yarn ou pnpm. Vamos selecionar o NPM e esperar algum tempo para instalação dos pacotes. Ele exibe também uma lista com os arquivos criados:
CREATE loja/ .eslintrec.js (665 bytes)
CREATE loja/prettierrc (51 bytes)
CREATE loja/nest-cli.json (118 bytes)
CREATE loja/package.json ( 1989 bytes)
CREATE loja/README.md (3340 bytes)
CREATE loja/tsconfig.build.json (546 bytes)
CREATE loja/src/app.controller.spec.ts (617 bytes)
CREATE loja/app.controller.ts (274 bytes)
CREATE loja/app.module.ts (249 bytes)
CREATE loja/app.service.ts (142 bytes)
CREATE loja/src/main.ts (208 bytes)
CREATE loja/test/app.e2e-spec.ts (630 bytes)
CREATE loja/test/jest-e2e.json (183 bytes)
Após executar, ele exibe a mensagem "Successfully created project loja" para indicar que nosso projeto foi criado e podemos entrar na pasta "loja" com o comando cd loja e executar o comando npm run start.Por padrão, o NPM executa o start se colocarmos apenas npm start.
Ele vai imprimir alguns logs e não informa em qual porta está executando. Podemos abrir uma nova aba no navegador e acessar no navegador o endereço http://localhost:3000. O Servidor estará ouvindo requisições na porta 3000 e veremos uma mensagem de Hello World.
Agora vamos abrir o código do projeto. Eu usarei o VS Code, você pode usar o editor que preferir.
No VS Code, vamos abrir a pasta onde criamos o projeto "loja".
Agora, na seção "explorador" do VS Code, podemos ver os arquivos criados para o nosso projeto. Temos, por exemplo, o package.json que já vem com vários comandos de build, de formatação de código, inicializar o servidor, testes configurados, etc.
O NestJS já traz todas as configurações de teste, podemos ver que foi criada a pasta "test" que tem um arquivo com o teste como exemplo.
na pasta "src" temos uma série de arquivos:
- app.controller.spec.ts
- app.controller.ts
- app.module.ts
- app.service.ts
- main.ts
O main.ts é o arquivo que inicializa o nosso projeto e fica ouvindo as requisições na porta 3000, app.listen(3000). Em breve entenderemos como os outros arquivos funcionam.
Primeiro, vamos dar uma olhada de onde vem aquele Hello World que acessamos no navegador. Vamos abrir o arquivo app.controller.ts:
import { Controller, Get} from '@nestjs/common';
import { AppService } from './app.service';
@Controller()
export class AppController {
constructor(private readonly appService: AppService) {}
@Get()
getHello(): string {
return this.appService.getHello();
}
}
Por ser em TypeScript o NestJS tem vários decorators para nós usarmos, isso facilita muito o desenvolvimento. Neste arquivos temos um @Controller, uma classe AppController, e tem um @Get() que retorna a execução do this.appService.getHello(). E o AppService é recebido no construtor da classe AppController.
Vamos clicar na classe AppService pressionando o "Ctrl", assim conseguimos abrir o arquivo app.service.ts:
import { Injectable } from '@nestjs/common';
@Injectable()
port class AppService {
getHello(): string {
return 'Hello World!';
}
}
Podemos ver que ele tem alguns decorators e tem o método getHello() que retorna o Hello World que vimos no navegador.
Inclusive, neste arquivo podemos substituir "Hello World" por "Minha Loja". Salvar este arquivo e atualizar a página no navegador.
A mensagem não mudou. O que aconteceu?
Nós inicializamos um servidor que não observa as mudanças nos nossos arquivos e por isso ele não reflete as atualizações na página do navegador. Para termos essa visualização contínua das atualizações acontecendo, precisamos executar o servidor de desenvolvimento.
Então, no terminal, vamos encerrar o processo e digitar/;
Ele vai inicializar em modo de desenvolvimento e ficará observando os arquivos. Agora, podemos atualizar a página no navegador e veremos que a mensagem que está na página mudou para "Minha Loja!".
Agora sim podemos iniciar a escrita de código da nossa aplicação. Começaremos no próximo vídeo!