📖 NARUTODEX - 🏗

Uma plataforma para procurar dados de Jutsus e Personagens de Naruto

💥 O que é?

Como o próprio nome sugere, NARUTODEX é uma espécie de Pokédex do universo Naruto. Nela você pode Encontrar Técnicas e Personagens da franquia, bem como suas informações. É possível descobrir os Jutsus de um Personagem ou os Personagens que executam determinada técnica. Além disso, as técnicas têm os selos utilizados para a sua execução.

💡 Motivação

O foco desse projeto é adquirir e aprimorar conhecimentos com o desenvolvimento web.

As principais tecnologias abordadas aqui são/serão Node Js utilizando Express e o ORM Sequelize para o back end e Next Js no front end.

Todos os dados da plataforma são coletados do Naruto Fandom, os dados são tratados e relacionados e então providos para o front end.

Para realizar as buscas e tratamentos de dados foi criado uma CLI que possibilita fazer as ações separadamente.

Todas as informações consumidas pertencem a Naruto Wiki.

📦 Tecnologias

Front-End

Esse é um projeto Next.js iniciado com o create-next-app.

• NEXT.js
• framer-motion
• styled components

Back-End

• Express
• sequelize ORM
• sqlite3

CLI

• inquirer
• ora

Hospedagem

• heroku
• vercel

📚 Requisitos

Ter Git para clonar o projeto.

Ter Node.js instalado.

Ter Yarn instalado.

⚙ Executando

🚀 Começando

  # Clonar o projeto:
  $ git clone https://github.com/lucasmg37/narutodex
  # Entrar no diretório:
  $ cd narutodex

🔗 Iniciando back-end

  # Entrar no diretório do back-end:
  $ cd backend
  # Instalar as dependências:
  $ yarn
  # Rodar a aplicação:
  $ yarn run dev 

O back-end será inicializado no endereço http://localhost:3333.

🖌 Iniciando front-end

  # Entrar no diretório do front-end:
  $ cd frontend-nextjs
  # Instalar as dependências:
  $ yarn
  # Rodar a aplicação:
  $ yarn run dev

O fron-tend será inicializado no endereço http://localhost:3000.

Importante

Este repositório contém o arquivo do banco de dados já populado, portanto não é necessário executar os comandos da CLI nem executar as migrations. Entretanto, caso deseje iniciar o projeto com o banco novo, siga os seguintes passos.

  #Rodar as migrations
  $ yarn sequelize db:migrate
  #Executar a classic
  # $ yarn run cli start - Em andamento

⌨ CLI

A CLI, foi criada para a inserção e atualização dos dados na base de dados dos dados provenientes do Fandom.

Ela é responsável por coletar os dados das páginas (HTML) e organizá-los de maneira relacional no banco de dados.

Para executar a CLI execute o seguinte comando em seu terminal estando na pasta backend.

  # Inicia a CLI
  $ yarn run cli start

Importante

A CLI não está totalmente criada, portanto não é possível executar todas as funções necessárias. Opte por usar o banco versionado no projeto.

🤝 Colabore

Viu algo de errado e quer ajudar? Pensou em algo bacana que gostaria de implementar?

Fique a vontade para abrir uma issue ou um Pull Request para o projeto. Conto com a sua ajuda.

✔️ To Do

• Estrutura inicial back end

• Coletar dados do Fandom

• Organizar dados coletados

• Criar endpoints para front-end

• Criar estrutura Next

• Criar tela principal com listagem de jutsus em forma de card

• Criar tela de busca

• Criar card de personagem

• Finalizar CLI para busca e tratamento de dados

• Adicionar Elementos dos Jutsus

• Adicionar Clã e Habilidades dos Personagens

Feito com ❤️ e ☕ por Lucas Junior 👋🏻