{ Universe Poke API }

Techs |  Estrutura do Projeto |  Funcionalidades |  Execução |  Dependencias |  Licença

🎮 Techs

Este projeto foi desenvolvido utilizando as seguintes tecnologias:

• TypeScript
• Node.js
• Express
• TypeORM
• Postgres
• Git

🧱 Estrutura do Projeto

src      
└───controllers
      └───Pokemon
            └───Pokemon.ts
└───database
      └───data-source.ts
└───entities
      └───Pokemon      
            └───Pokemon.ts         
└───routes.ts
└───server.ts
.env
.eslintrc.json
.gitignore
package.json
README.md
tsconfig.json
yarn.lock

🚩 Funcionalidades

• Adicionar Pokémon
• Remover Pokémon
• Atualizar dados do Pokémon
• Pesquisar todos os Pokémon's
• Pesquisar Pokémon por número de Pokédex

🕹️ Execução do Projeto

git clone https://github.com/devcodecampos/universe-poke-api

cd universe-poke-api

yarn install

yarn dev

Criar arquivo .env na raiz do projeto com as seguintes variáveis de ambiente, lembrando que são apenas exemplos, configure de acordo com seu ambiente

TYPEORM_CONNECTION = postgres "O driver do banco de dados que você está usando"
TYPEORM_HOST = localhost "O endereço do host do seu banco"
TYPEORM_USERNAME = postgres "O nome de usuário usado para autenticar no banco"
TYPEORM_PASSWORD = 123456 "A senha associada ao usuário do banco"
TYPEORM_DATABASE = universe-poke "O nome do banco ao qual deseja se conectar"
TYPEORM_PORT = 5432 "A porta na qual o seu banco está configurado"
SERVER_PORT=3333 "A porta na qual o servidor do seu aplicativo será executado"

📚 Dependencias

Typescript

yarn add -D typescript

ts-node-dev

yarn add -D ts-node-dev

ESLint

yarn add -D eslint
yarn run eslint --init

Express

yarn add express

TypeORM

yarn add typeorm 
yarn add reflect-metadata

Postgres

yarn add pg pg-hstore

Dotenv

yarn add -D dotenv

📝 Licença

MIT License

🤖Autor

Feito por Matheus Campos