alquipo/pokedex

A simple pokedex using TypeScript, React, NextJS, Styled Components, Storybook, GraphQL and Jest

🚧 Pokedex | Em Construção 🚧

Bem Vindo a Pokedex

🚀 Sobre o Projeto

Pokedex desenvolvida usando nextJS + GraphQL + Styled Components. Ideia do projeto e criar todos os componentes manualmente, utilizar o mínimo de biblioteca externas. Foram adicionados test e storybook no projeto.

🎨 Layout

Design Inspirado no HybridShivam

Web

Theme Light

Storybook

🎉 Features da Aplicação

-Uso do NextJS;
-Geração uso de paginas estáticas dinâmicas;
-Uso de Graphql como API;
-Styled Components;
-Adicionado testes com Jest;
-Adicionado Storybook;

🎖 Milestone

-Adicionar search bar;
-Adicionar minimalist layout;
-Adicionar modal information;
-Adicionar mais pokemon information;

🔨 Tecnologias:

• TypeScript
• NextJS
• GraphQL
• Bootstrap
• React-Bootstrap
• Nprogress
• Styled Components
• Jest
• React Testing Library
• Storybook
• Eslint
• Prettier
• Husky
• PlopJS
• Polished
• Styled-Icons

🔎 Comandos

• dev: Executa a aplicação em localhost:3000
• build: Cria a Build do projeto
• start: Inicia um servidor simples com o código de produção
• lint: Executa o Linter em todos os componentes e páginas
• test: Executa Jest para testar todos os componentes e páginas
• test:watch: Executa Jest em watch mode
• storybook: Executa Storybook em localhost:6006
• build-storybook: Cria uma build do storybook
• generate: Cria automaticamente um componente

🚀 Como rodar este projeto

Para clonar e executar este aplicativo, você precisará de Git e NodeJs Instalado em seu computador.

🌀 Clonando o repositório

# Clone este repositório
$ git clone https://github.com/Alquipo/pokedex

# Acesse a pasta do projeto no terminal/cmd
$ cd pokedex

🎲 Rodando a Aplicação

# Instale as dependências
$ yarn install

# Execute a Aplicação em Desenvolvimento
$ yarn dev

# O servidor inciará na porta:3000 - acesse http://localhost:3000

💾 Comandos Úteis

#Criação de um componente completo com (index.tsx / stories.tsx / styles.ts / test.tsx)
$ yarn generate ComponentName

#Rodar o Storybook
$ yarn storybook

#Rodar os testes
$ yarn test

🤔 Como contribuir para o projeto

• Faça um fork do projeto;
• Crie uma nova branch com as suas alterações: git checkout -b my-feature
• Salve as alterações e crie uma mensagem de commit contando o que você fez:git commit -m "feature: My new feature"
• Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT. Veja a LICENÇA para saber mais.

Feito com ❤️ por Alquipo Neto 👋🏽 Entre em contato!