Rec-avatar-creator2 NPM

Avatar Creator

Interface de componente responsável por criar e customizar avatares, seguindo o modelo de Identidade visual dos componentes - Avatar Creator, este projeto deverá ser utilizado por outras plataformas e como sua saída deve prover um .png ou .jpg ou até mesmo uma url para o avatar customizado pelo usuário.

Documentos de referência

Funcionalidades implementadas

.......

Pré-requisitos

Para execução da aplicação é necessário ter instalado no ambiente os softwares abaixo nas versões descritas ou superiores:

Node 18.17.1
Npm 9.6.7

Principais dependências

React v18.2
React Router v6.18
React App Rewired v2.2
Material UI v5.14.15
Material UI Icons v5.14.15
Axios v1.6
TypeScript

Instalação e execução via Docker

Para facilitar instalação e execução da aplicação foi implementado containers Docker, onde é realizado o processo de build e execução.

Para facilitar, durante as implementações existe o arquivo docker-compose-local.yml que possui mapeamento de disco (-v) onde as alterações no código são refletidas para dentro do container e é executado um command * *npm run start** que sobe a aplicação em modo de desenvolvimento.

Já o docker-compose.yml não possui este mapeamento de disco, no Dockerfile associado existe o npm run build que gera uma build da aplicação e gerado a pasta dist é copiada para o Nginx quando o serviço estiver sendo integrado com outra aplicação ou em produção.

Estrutura dos arquvios Docker:

Dockerfile: responsável por instalar dependências e realizar o build e criar o servidor Nginx
DockerfileLocal: responsável por realizar instalar dependências
docker-compose.yml: responsável por realizar o build e execução do container principal (produção)
docker-compose-local.yml: responsável por realizar o build e execução do container principal, com mapeamento de disco (desenvolvimento)

Os passos abaixo devem ser executados na raiz do projeto.

Build

    docker-compose -p avatar-creator-webcomponent -f docker-compose/docker-compose.yml build

Run(up)

    docker-compose -p avatar-creator-webcomponent -f docker-compose/docker-compose.yml up -d

Down

    docker-compose -p avatar-creator-webcomponent -f docker-compose/docker-compose.yml down

Instalação e execução local

Para instalar dependências e subir o ambiente de forma local, execute os comandos npm abaixo

Instalar dependencias

    npm install

Start(Modo de Desenvolvimento)

    npm run start

Build (Gerar a "dist" para produção)

    npm run build

Autores

Bruno F Godoi - bruno.godoi@reciclarequalidade.com.br