Skip to content

Latest commit

 

History

History
148 lines (106 loc) · 4.82 KB

README.md

File metadata and controls

148 lines (106 loc) · 4.82 KB
Raw

Fakenews App

Tabela de Conteúdo

Sobre o Projeto

Este projeto é uma criação de uma aplicação web referente a disciplina de Desenvolvimento de Software do curso de Computação da Universidade Federal de Pelotas.

Feito Com

Abaixo segue o que foi utilizado na criação desta aplicação:

Backend

  • Node.js - Node.js é JavaScript runtime assíncrono orientado a eventos que foi projetado para construir aplicativos de rede escalonáveis;
  • Npm - npm é o maior registro de software do mundo. Os desenvolvedores de código aberto de todos os continentes usam o npm para compartilhar e emprestar pacotes;
  • Express - O Express é um framework para aplicativo da web do Node.js mínimo e flexível que fornece um conjunto robusto de recursos para aplicativos web e móvel;
  • Mysql js - Este é um driver node.js para mysql. Ele é escrito em JavaScript, não requer compilação e é 100% licenciado pelo MIT;
  • Cors - CORS é um pacote node.js para fornecer um middleware Connect / Express que pode ser usado para habilitar CORS com várias opções;
  • Bcript.js - Bcript.js é um pacote node.js utilizado para fazer criptografias;

Front-end

  • React.js - Uma biblioteca JavaScript para criar interfaces de usuário;
  • Yarn - O Yarn é um gerenciador de pacotes que trouxe mais funcionalidades e vantagens para programadores. Com uma estrutura já conhecida e utilizada por ferramentas renomadas, como o NPM, essa aplicação tem se destacado por sua simplicidade e segurança;
  • Router dom - lib completa para controle de rotas que permite que você consiga configurar as rotas utilizando o formato JSX e também disponibiliza uma API para você configurar diretamente via Javascript;
  • Styled Components - A biblioteca Styled Components permite que você escreva CSS simples para seus componentes sem se preocupar com colisões dos nomes de classes. Ajuda a escrever CSS com escopo definido para um único componente e não se aplica em nenhum outro elemento da página.;
  • React Hook Form - A biblioteca traz a proposta de criar formulários flexíveis, com formas simples de fazer validação e sem renderizações desnecessárias.;

Começando

Para conseguir utilizar a aplicação é preciso seguir as etapas a seguir.

Pré-requisitos

Antes de seguirmos para as configurações e uso, é ideal que você tenha o ambiente configurado para criar e testar a aplicação web. E para isso você deverá ter instalado:

Backend

  • node.js
  • npm

Estrutura de Arquivos

A estrutura de arquivos está da seguinte maneira:

Backend

backend
├── src/
│   ├── config/
│   │   └── db.config.js
│   ├── controllers/
│   │   ├── noticias.js
│   │   └── users.js
│   ├── database/
│   │   └── connection.js
│   │   └── db.sql
│   │   └── delete-db.sql     
│   ├── models/
│   │   └── noticia.js
│   │   └── usuario.js
│   ├── routes/
│   │   └── home.js
│   │   └── noticia.js
│   │   └── user.js
│   ├── index.js
│   ├── package-lock.json
│   └── package.json
├── .gitignore
└── README.md

Instalação

Backend

No diretório backend/src/

  1. Instalar as dependências:
npm install
  1. Iniciar o servidor em localhost:
npm run server
  1. Criar banco de dados local:

Necessita a instalação do Mysql na máquina local

3.1 Criar banco:

npm run create-sql

3.2 Inicializar banco com configurações default:

npm run init-sql

3.3 Deletar banco:

npm run delete-sql

Front-end

No diretório fakenews-app/

  1. Instalar as dependências:
npm install
  1. Iniciar o software em localhost:
npm start