/typext-webservice

Primary LanguageTypeScript

typext_cover

Requisitos necessários para o funcionamento do software

  • Para executar o projeto será necessário a instalação do NodeJS e Docker.

Instalação do NodeJS Linux

  • Execute os comandos abaixo no terminal:

Ubuntu

curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

Debian, as root

curl -fsSL https://deb.nodesource.com/setup_14.x | bash -
apt-get install -y nodejs

Instalação do NodeJS Windows

  • Acesse o site do NodeJS e baixe a versão LTS:

image

Instalação do Docker

  • Para instalar o Docker Engine, acesse o site do Docker e escolha a distribuição da sua preferência.
  • Siga todos os passos listados.
  • Por fim, para que não precise utilizar o sudo, execute os comandos presentes nessa página.

Container Docker

  • Agora deve-se criar um container com a imagem do PostgreSQL, executando:
# No lugar de your-password adicione a senha que desejar

docker run --name postgres -e POSTGRES_PASSWORD=your-password -e POSTGRES_DB=typext -p 5432:5432 -d postgres
  • Neste momento seu container desse estar executando. Para confirmar execute:
docker ps
  • Caso não tenha iniciado, execute:
docker start postgres
  • E para parar o container, execute:
docker stop postgres

Iniciando a aplicação

  • Após fazer o clone do projeto, execute yarn ou npm install para instalar todas as dependências necessárias para que o projeto funcione.
  • Agora os arquivos com variaǘeis ambiente (.env) e de conexão com o banco de dados (ormconfig.json) devem ser criados na raiz do projeto, dessa forma:

image

  • Adicione o seguinte conteúdo em cada um deles:

.env

# Application
APP_SECRET=typext

APP_WEB_URL=http://localhost:3000
APP_API_URL=http://localhost:3333

#Mail
MAIL_DRIVER=ethereal

ormconfig.json

{
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  "username": "postgres",
  "password": "your-password",
  "database": "typext",
  "entities": [
    "./src/modules/**/infra/typeorm/entities/*.ts"
  ],
  "migrations": [
    "./src/shared/infra/typeorm/migrations/*.ts"
  ],
  "cli": {
    "migrationsDir": "./src/shared/infra/typeorm/migrations"
  }
}
  • Feito isso, as migrations precisarão ser executadas para que as tabelas sejam criadas no banco de dados. Para isso, utilize o comando abaixo:
yarn typeorm migration:run

# ou

npm typeorm migration:run
  • Para a criação do primeiro usuário será necessário rodar o comando:
npm run seed:admin 

# ou 

yarn seed:admin

Esse usuário tem os valores defalt:

email: admin@typext.com.br

password: admin

  • Neste momento o servidor pode ser iniciado com o comando:
yarn dev:server

# ou

npm run dev:server
  • A seguinte mensagem mostra que o servidor foi iniciado:

image

Testando a aplicação

  • Para executar os testes, utilize o comando abaixo:
yarn test

# ou

npm test

O seguinte relatório aparecerá no terminal:

image