deywersonp / nlw-return-feedget-reactjs

Feedget is a project developed with the objective of collecting information about the application through user feedback, allowing users to send a message and a screenshot of the screen at any time. This project was developed during NLW Return - Impulse.

Feedget

Project   |    Technologies   |    Services Used   |    Getting Started   |    How To Use   |    Features   |    Layout   |    License

💻 Project

Feedget is a project developed with the objective of collecting information about the application through user feedback, allowing users to send a message and a screenshot of the screen at any time.

🚀 Technologies

This project was developed using these techs:

• React
• TypeScript
• TailwindCSS
• i18n
• html2Canvas

👨‍🔧 Services Used

• Vercel

🎮 Getting Started

If you want run this code, you can start cloning the repository using HTTP or SSH key.

• Open your gitBash (git terminal)
• Type git clone
• Insert the HTTP or SSH key (on windows, shift + insert to paste on gitBash)
• You can find this HTTP or SSH Key by clicking on Code on the top right in this repository

• Once cloned you can open the project in your IDE and enter the codes below in the IDE terminal
  

npm install To add the dependencies on the project.

npm run dev Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

PS: You may need run the api to test. You can get the API code source by clicking here.

Dependencies

• Axios
• i18n
• html2canvas
• Tailwind

📌 How to Use

1 - When you access the project, you will see the home page. In this page you can:

1.1 - Choose a feedback option

1.2 - Write a feedback and take a screenshot

1.3 - Send the feedback

🕵 Features

The main features of the application are:

• Send a feedback with a screenshot

🔖 Layout

You can see the layout of this project through this link. It's necessary have an account on Figma to access.

📝 License

This project is under MIT license.

In case of sensitive bugs like security vulnerabilities, please contact [e-mail] directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!

---

Please follow on github and join us! Thanks for visiting me and good coding!

Made with ♥ by Deywerson Pereira