🚧 #33

mjgargani's Lab

🌐 https://gargani.dev/

Descrição / Description

Portfolio desenvolvido com ReactJS (Vite) + TypeScript (Saiba como), no ano de 2023. A aplicação é uma interface que consome, modela e armazena em cache, recursos da API do GitHub.

Portfolio developed with ReactJS (Vite) + TypeScript (Learn how), in the year 2023. The application is an interface that consumes, models and caches GitHub API resources.

⚠️ Anteriormente, o projeto usava o CRA para desenvolvimento e geração de builds. Porém, o Vite torna o desenvolvimento muito mais rápido e otimizado, a medida que ultrapassa limitações que os empacotadores tradicionais possuem (Saiba mais).

⚠️ Previously, the project used CRA to development and generation of builds. However, Vite makes development much faster and more optimized, as it overcomes limitations that traditional bundlers have (Learn more).

⭐ O projeto é publicado através do GitHub Pages. O CI/CD é feito com o apoio do GitHub Actions.

⭐ The project is published through GitHub Pages. CI/CD is powered by GitHub Actions.

O projeto também conta com uso de styled-components para criação e estilização dos componentes, o Marked para interpretação de texto no formato Markdown e o React Icons.

The project also uses styled-components to create and style components, Marked to interpret text in Markdown format and React Icons.

Como rodar / How to run

⚠️ Necessita de um navegador web e do NodeJS. O projeto foi testado utilizando a versão 18.15.0.

⚠️ Requires a web browser and NodeJS. The project was tested using version 18.15.0.

npm i # Install the packages / Instale os pacotes

npm run dev # Run the `dev` script / Rode o script `dev`

Após a compilação ocorrer, use o navegador para acessar o endereço http://localhost:5173/.

After compilation takes place, use the browser to access the address http://localhost:5173/.

Rodar com o Docker / Run with Docker

⚠️ Necessita do Docker instalado no host para funcionar.

⚠️ Requires Docker installed on the host to work.

docker run -it --rm -v $(pwd):/app -p 5173:5173 node:18.15.0-alpine sh -c "npm --prefix=/app i && npm --prefix=/app run dev -- --host"

Após a compilação ocorrer, use o navegador para acessar o endereço http://localhost:5173/.

After compilation takes place, use the browser to access the address http://localhost:5173/.

Rodar a build com nginx (Docker-compose) / Run the build with nginx (Docker-compose)

Como rodar / How to run

⚠️ Necessita de um navegador web e do Docker instalado no host para funcionar.

⚠️ Requires a web browser and Docker installed on the host to work.

docker compose up -d --build

Após iniciar o container, use o navegador para acessar o endereço http://localhost:8080/.

After starting the container, use the browser to access the address http://localhost:8080/.

Como parar / How to stop

docker compose down