/Planeje

Aplicação Full stack que permite o gerenciamento de tarefas.

Primary LanguageTypeScript

Planeje

Planeje é uma aplicação fullstack que possibilita o gerenciamento de tarefas onde é possível criar, editar, atualizar ou excluir tarefas de maneira independente.

Demo

Backend

O Backend da aplicação consiste em uma api que utiliza os princípios de arquitetura REST, com 5 endspoints, utilizando o bando de dados POSTGRES e documentada com swagger, com 100% de cobertura de teste sendo esses de integração e unitários utilizando o método In Memory de testes e CI através do github actions e deploy no railway.

Documentação

A Documentação completa da api feita com o swagger pode ser acessada através do link abaixo.

Swagger

Com o swagger é possível a interação com os 5 endspoints sendo possível testá-los obtendo exemplos e a repostas de forma independente.

Frontend

O Frontend da aplicação conta com uma interface feita em react, e estilizada com styled-components, onde através da biblioteca de requisição axios, é possível executar e consumir as operações do crud, também é utilizado o layout respondível e RTL para testar a funcionalidade dos componentes.

Aplicação

Link da aplicação Frontend com deploy feito no vercel já integrada com o Backend rodando no railway.

Planeje

Rodar Localmente

Para rodar a aplicação você pode escolher rodar através de um container no docker ou localmente com node.

Docker

Pré-Requisitos

Para rodar a aplicação é necessário ter instalado corretamente o Docker e o Docker-Compose.

Rodando no Docker

Clone o projeto

  git clone git@github.com:fpdsjr/Projete.git

Navegue até o diretório do projeto

  cd Projete

Rode a aplicação no docker

  docker-compose up -d --build

Apos conclusão da montagem do container a aplicação vai estar disponível nos endereços abaixo:

  Backend: http://localhost:3333
  Frontend: http://localhost:3000
Node

Pré-Requisitos

Para rodar a aplicação é necessário ter instalado o Node e um banco de dados funcionando PostgreSQL

Rodando no Node

O Projeto conta com um repositório monorepo, então para tudo funcionar corretamente precisamos ligar o Frontend e o Backend de maneira independente, siga os passos abaixo.

Clone o projeto

  git clone git@github.com:fpdsjr/Projete.git

Navegue até o diretório do projeto

  cd Projete

Entre no diretório server para ligar o Backend

  cd server

Instalando as dependências

  yarn

Rodando Localmente

  yarn start

Pronto agora temos o Backend rodando

  Backend: http://localhost:3333

Vamos para a parte do Frontend.

Volte de diretório para a raiz do projeto

  cd ..

Entre no diretório onde esta contido o frontend

  cd web

Instalando as dependências

  yarn

Ligando o frontend

  yarn start

Agora com o Frontend Ligado temos a aplicação funcionado já integrada com o Backend e funcionando

  Frontend: http://localhost:3000

Rodando os testes

Frontend

Entre no diretório web

  cd web

Instalando as dependências

  yarn

Rodando os testes

  yarn test
Backend

Entre no diretório server

  cd server

Instalando as dependências

  yarn

Rodando os testes

  yarn test

Tech Stack

Web

  • React
  • TypeScript
  • React Hooks
  • Custom Hooks
  • Styled-Components
  • Docker
  • Axios
  • Eslint
  • Jest

Server

  • Node
  • TypeScript
  • Express
  • Prisma
  • PostegreSQL
  • Docker
  • Swagger
  • Eslint
  • Jest
  • Tsyringe

Authors