Este projeto tem como finalidade ajudar você a descobrir quais são as possíveis transportadoras para a sua entrega da Shopee.
Para executar de forma convencional em sua máquina você precisará de:
Com tudo isso em mãos, execute:
pnpm install
e em seguida
pnpm dev
para executar a versão de desenvolvimento. Ou
pnpm build
pnpm start
para usar a versão de produção.
Por fim basta acessar: localhost:3000
e pronto :)
Para usar a versão de produção já compilada com docker, rode:
docker run -d -p 3000:3000 dpbm32/shopee-entrega-padrao
ou se preferir pode usar o docker compose
:
docker-compose up -d
após isso, para acessar basta ir para <docker_ip>:3000
, caso você não saiba o docker_ip
:
- com o container rodando, execute
docker ps
e pegue oContainer ID
; - execute:
docker inspect <container_id> | grep IPAddress
.
Os testes foram feitos utilizando o cypress
, para vê-los de forma gráfica em um browser rode
pnpm cypress:open
ou para rodá-los no terminal headless
, use:
pnpm cypress:run
contudo, este ultimo necessita de um instancia rodando do sistema em localhost:3000
, para solucionar isso use:
pnpm test
Existem diversas maneiras para contribuir com esse projeto, aqui estão algumas:
- resolver bugs
- resolver typos
- adicionar mais transportadoras
- ajudar a melhorar o site
se você tem alguma ideia de como ajudar, não seja tímido, abra uma ISSUE
ou ainda crie um PULL REQUEST
. Sua ajuda é sempre bem-vinda :)