... | @@ -27,7 +27,7 @@ Bem-vindo à página de configuração de projetos! Aqui, você encontrará toda |
... | @@ -27,7 +27,7 @@ Bem-vindo à página de configuração de projetos! Aqui, você encontrará toda |
|
|
|
|
|
Este é o backend do projeto Cosmos, construído com Node.js, TypeScript e o framework NestJS. O banco de dados é gerenciado com PostgreSQL, e o projeto utiliza Prisma como ORM.
|
|
Este é o backend do projeto Cosmos, construído com Node.js, TypeScript e o framework NestJS. O banco de dados é gerenciado com PostgreSQL, e o projeto utiliza Prisma como ORM.
|
|
|
|
|
|
## Índice
|
|
### Índice
|
|
|
|
|
|
- [Pré-requisitos](#pré-requisitos)
|
|
- [Pré-requisitos](#pré-requisitos)
|
|
- [Instalação](#instalação)
|
|
- [Instalação](#instalação)
|
... | @@ -39,7 +39,7 @@ Este é o backend do projeto Cosmos, construído com Node.js, TypeScript e o fra |
... | @@ -39,7 +39,7 @@ Este é o backend do projeto Cosmos, construído com Node.js, TypeScript e o fra |
|
- [Documentação da API](#documentação-da-api)
|
|
- [Documentação da API](#documentação-da-api)
|
|
- [Contribuindo](#contribuindo)
|
|
- [Contribuindo](#contribuindo)
|
|
|
|
|
|
## Pré-requisitos
|
|
### Pré-requisitos
|
|
|
|
|
|
Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua máquina:
|
|
Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua máquina:
|
|
|
|
|
... | @@ -49,7 +49,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
... | @@ -49,7 +49,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
|
- Docker
|
|
- Docker
|
|
- Git
|
|
- Git
|
|
|
|
|
|
## Instalação
|
|
### Instalação
|
|
|
|
|
|
1. **Clone o repositório:**
|
|
1. **Clone o repositório:**
|
|
|
|
|
... | @@ -71,7 +71,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
... | @@ -71,7 +71,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
|
yarn install
|
|
yarn install
|
|
```
|
|
```
|
|
|
|
|
|
## Configuração do Ambiente
|
|
### Configuração do Ambiente
|
|
|
|
|
|
1. **Crie um arquivo `.env` no diretório raiz** e adicione as seguintes variáveis de ambiente:
|
|
1. **Crie um arquivo `.env` no diretório raiz** e adicione as seguintes variáveis de ambiente:
|
|
|
|
|
... | @@ -91,7 +91,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
... | @@ -91,7 +91,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
|
DATABASE_URL="postgresql://postgres:cosmos@localhost:5432/cosmos_db?schema=public"
|
|
DATABASE_URL="postgresql://postgres:cosmos@localhost:5432/cosmos_db?schema=public"
|
|
```
|
|
```
|
|
|
|
|
|
## Configuração do Banco de Dados
|
|
### Configuração do Banco de Dados
|
|
|
|
|
|
1. **Crie o banco de dados PostgreSQL:**
|
|
1. **Crie o banco de dados PostgreSQL:**
|
|
|
|
|
... | @@ -115,7 +115,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
... | @@ -115,7 +115,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
|
npx prisma db seed
|
|
npx prisma db seed
|
|
```
|
|
```
|
|
|
|
|
|
## Executando a Aplicação
|
|
### Executando a Aplicação
|
|
|
|
|
|
1. **Inicie o servidor de desenvolvimento:**
|
|
1. **Inicie o servidor de desenvolvimento:**
|
|
|
|
|
... | @@ -131,7 +131,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
... | @@ -131,7 +131,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
|
|
|
|
|
O servidor será iniciado em `http://localhost:3001`.
|
|
O servidor será iniciado em `http://localhost:3001`.
|
|
|
|
|
|
## Formatação e Linting de Código
|
|
### Formatação e Linting de Código
|
|
|
|
|
|
1. **Prettier** é utilizado para formatação de código. Você pode formatar seu código executando:
|
|
1. **Prettier** é utilizado para formatação de código. Você pode formatar seu código executando:
|
|
|
|
|
... | @@ -145,7 +145,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
... | @@ -145,7 +145,7 @@ Antes de clonar o repositório, certifique-se de ter o seguinte instalado em sua |
|
npm run lint
|
|
npm run lint
|
|
```
|
|
```
|
|
|
|
|
|
## Hooks do Git
|
|
### Hooks do Git
|
|
|
|
|
|
O Husky está configurado para garantir a qualidade do código antes dos commits:
|
|
O Husky está configurado para garantir a qualidade do código antes dos commits:
|
|
|
|
|
... | @@ -157,7 +157,7 @@ O Husky está configurado para garantir a qualidade do código antes dos commits |
... | @@ -157,7 +157,7 @@ O Husky está configurado para garantir a qualidade do código antes dos commits |
|
npm run prepare
|
|
npm run prepare
|
|
```
|
|
```
|
|
|
|
|
|
## Documentação da API
|
|
### Documentação da API
|
|
|
|
|
|
A documentação da API é gerada automaticamente com o Swagger e está disponível em:
|
|
A documentação da API é gerada automaticamente com o Swagger e está disponível em:
|
|
|
|
|
... | @@ -169,15 +169,15 @@ http://localhost:3001/api |
... | @@ -169,15 +169,15 @@ http://localhost:3001/api |
|
|
|
|
|
Nesta sessão, vamos apresentar o passo a passo de como instalar e configurar um ambiente de desenvolvimento local para utilizar o React pré-configurado para TypeScript.
|
|
Nesta sessão, vamos apresentar o passo a passo de como instalar e configurar um ambiente de desenvolvimento local para utilizar o React pré-configurado para TypeScript.
|
|
|
|
|
|
#### O que é React?
|
|
### O que é React?
|
|
|
|
|
|
O React é uma biblioteca JavaScript que permite criar interfaces com o usuário de forma declarativa, flexível e eficiente. Essa biblioteca é de código aberto e permite a composição de UI's complexas a partir de pequenos e isolados códigos denominados "componentes". Em outras palavras, o React é uma ferramenta que ajuda a construir a interação entre humanos e máquinas por meio de elementos como botões, menus e sons, tornando essa interação mais fácil e intuitiva.
|
|
O React é uma biblioteca JavaScript que permite criar interfaces com o usuário de forma declarativa, flexível e eficiente. Essa biblioteca é de código aberto e permite a composição de UI's complexas a partir de pequenos e isolados códigos denominados "componentes". Em outras palavras, o React é uma ferramenta que ajuda a construir a interação entre humanos e máquinas por meio de elementos como botões, menus e sons, tornando essa interação mais fácil e intuitiva.
|
|
|
|
|
|
#### O que é TypeScript?
|
|
### O que é TypeScript?
|
|
|
|
|
|
O TypeScript é uma linguagem de programação de código aberto, desenvolvida pela Microsoft, que funciona como um superset de JavaScript. Ele adiciona recursos como tipagem estática opcional à linguagem, tornando-a mais robusta e poderosa, especialmente para projetos complexos. Em outras palavras, o TypeScript é uma ferramenta que amplia as funcionalidades da linguagem JavaScript, proporcionando maior eficiência e produtividade no desenvolvimento de aplicações.
|
|
O TypeScript é uma linguagem de programação de código aberto, desenvolvida pela Microsoft, que funciona como um superset de JavaScript. Ele adiciona recursos como tipagem estática opcional à linguagem, tornando-a mais robusta e poderosa, especialmente para projetos complexos. Em outras palavras, o TypeScript é uma ferramenta que amplia as funcionalidades da linguagem JavaScript, proporcionando maior eficiência e produtividade no desenvolvimento de aplicações.
|
|
|
|
|
|
## Requisitos
|
|
### Requisitos
|
|
|
|
|
|
O editor escolhido é o Visual Studio Code, desenvolvido pela Microsoft para sistemas operacionais Windows, Linux e macOS, possui diversas funcionalidades, tais como suporte para depuração, controle de versionamento Git integrado, realce de sintaxe, complementação inteligente de código, snippets e refatoração de código.
|
|
O editor escolhido é o Visual Studio Code, desenvolvido pela Microsoft para sistemas operacionais Windows, Linux e macOS, possui diversas funcionalidades, tais como suporte para depuração, controle de versionamento Git integrado, realce de sintaxe, complementação inteligente de código, snippets e refatoração de código.
|
|
|
|
|
... | @@ -187,12 +187,12 @@ Para utilizarmos o React e rodar as aplicações no navegador será necessário |
... | @@ -187,12 +187,12 @@ Para utilizarmos o React e rodar as aplicações no navegador será necessário |
|
- [Node.js](https://nodejs.org/en)
|
|
- [Node.js](https://nodejs.org/en)
|
|
- [VS Code](https://code.visualstudio.com/download)
|
|
- [VS Code](https://code.visualstudio.com/download)
|
|
|
|
|
|
#### Extensões Obrigatórias
|
|
### Extensões Obrigatórias
|
|
|
|
|
|
- [ESlint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
- [ESlint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
|
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
|
|
|
|
|
#### Instalação
|
|
### Instalação
|
|
|
|
|
|
Adicionar um arquivo na raiz do projeto com o nome ".env".
|
|
Adicionar um arquivo na raiz do projeto com o nome ".env".
|
|
O arquivo deve ter como conteúdo:
|
|
O arquivo deve ter como conteúdo:
|
... | | ... | |