/pokemon-api

Pokemon API

Primary LanguageJavaScript

Pokémon API

API desenvolvida com NodeJS para CRUD de Pokémons

🚀 Features

  • Cadastro e autenticação de usuários
  • Upload de avatar do pokemon
  • Atualização de dados do usuário
  • Listagem de pokémons
  • Detalhes de um pokemon expecífico
  • Cadastro de pokémons
  • Atualização de pokémons
  • Exclusão de pokémons

🛠️ Tecnologias


💻 Requisitos

⚙️ Como executar a aplicação

# Clone este repositório
$ git clone <https://github.com/gaoliveira21/pokemon-api.git>

# Acesse a pasta do projeto no terminal/cmd
$ cd pokemon-api

# Instalar as dependências
$ yarn

# Criar arquivo .env na raiz do projeto usando o arquivo .env.example como modelo
$ cp .env.example .env # Unix
$ copy .env.example .env # Windows

# Iniciando os containers
$ docker-compose up -d --build

# O servidor inciará na porta:3333 - acesse <http://localhost:3333>

🔧 Executando os testes

# Criar arquivo .env.test seguindo como modelo o arquivo .env.example
$ cp .env.example .env.test # Unix
$ copy .env.example .env.test # Windows

# Executando os testes
$ yarn test

📋 Documentação


📝 License

Esse projeto está sob MIT license. Veja LICENSE para mais informações.


👷 Feito por Gabriel Oliveira 😃 - Contato: Linkedin