README.md

🚀 Feedget 🚀

Project | Technologies | Features | Getting started | License

💻 Project

Web version of a feedback widget application, dubbed "Feedget", which can be added to any mobile or web environment.

The user chooses a type of feedback to be sent, after that a description is requested for the feedback and optionally the user can automatically add a screenshot, after sending the feedback will be registered in the database and an email will be automatically sent to the website/application owner.

Project developed during Rocketseat's Next Level Week Return

Access the running application: https://feedget-app.vercel.app

API: Feedback Widget (API)

Mobile version: Feedback Widget (Mobile)

🚀 Technologies

• ReactJS
• Typescript
• Tailwind CSS
• Vite
• Axios
• Headless UI
• Phosphor Icons
• html2canvas

🛠 Features

✔️ Send text feedback

✔️ Button to send automatic screenshot, requiring no other user action

✔️ Automatic emailing to website/app developer

✔️ Possibility of sending a new feedback at the end

🏁 Getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

git clone https://github.com/LuccaDi/feedback-widget-web.git && cd feedback-widget-web

Follow the steps below

Web

Make sure you have the server running (or you will only be able to see the front-end, the application will not work)

To clone the server and run it, go to Feedback Widget (API)

# Install the dependencies
$ npm install

# Make a copy of '.env.local.example' to '.env.local'
$ cp .env.local.example .env.local

# Start the application
$ npm run dev

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ by Lucca Di Bastiani