jose-bone / feedback-widget

Projeto desenvolvido na trilha Impulse na NLW #08

Feedback Widget

 

Demo

Status

🚧 Feedback Widget 🚀 Under construction... 🚧

---

Sobre   |   Funcionalidades   |   Tecnologias   |   Requisitos   |   Como rodar   |   Licença   |   Autor

🎯 Sobre

Interface de um widget para enviar comentários de feedbacks

✨ Funcionalidades

• ✔️ Envio de feedbacks
• ✔️ Screenshot com html2canvas
• ✔️ Uso do MailTrap para simular envio de e-mails com os feedbacks

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

• Node.js
• React
• React Native
• Expo
• Tailwind CSS
• Vite
• MailTrap
• PostgreSQL
• html2canvas
• TypeScript

✅ Requisitos

Antes de iniciar 🏁, você precisa ter instalado o Git e Node.

👷 Como rodar

# Clone o Repositório
$ git clone https://github.com/jose-bone/feedback-widget.git

# Entre na pasta
$ cd feedback-widget

📦 Rode o Servidor

# Vá para a pasta do servidor
$ cd server

# Instale as dependências
$ yarn install

# Faça uma copia do arquivo `.env.example` para `.env` e informe suas credenciais

# Crie o banco de dados via migrate
$ npx prisma migrate dev

# Rode a aplicação
$ yarn dev

Acesse a API: http://localhost:3333/

💻 Rode o Projeto Web

# Vá para a pasta web
$ cd web

# Instale as dependências
$ yarn install

# Faça uma copia do arquivo `.env.example` para `.env` e informe suas credenciais

# Rode a aplicação
$ yarn dev

Acesse: http://localhost:3000/ para ver o resultado.

📱 Rode o Projeto Mobile

Para rodar o projeto mobile você precisa de um celular com o expo instalado ou um emulador android/ios.

# Vá para a pasta mobile
$ cd mobile

# Instale as dependências
$ yarn install

# Rode a aplicação
$ yarn start

Depois leia o QRCode com o app do expo ou rode em um emulador.

🐛 Problemas

Fique a vontade para criar uma nova issue com o respetivo titulo e descrição na página de issues do Feedback Widget. Se você já encontrou a solução para o problema, Eu amaria fazer o review do seu pull request!

♻ Como contribuir

• Faça fork deste repositório,
• Crie uma branch com a sua feature: git checkout -b my-feature
• Commit suas mudanças: git commit -m 'feat: My new feature'
• Push a sua branch: git push origin my-feature

📝 Licença

Esse projeto está sob a licença MIT. Para mais detalhes, veja o arquivo LICENSE.

Made with ❤️ by José Boné

 

Back to top