/feedback-widget

This is a monorepo project developed in the NLW #08 Mission - Return. This project allows the user to send a feedback with details.

Primary LanguageTypeScriptMIT LicenseMIT

Feedback Widget logo

License NLW 08

cover

๐Ÿ’ป Project

This is a monorepo project developed in the NLW #08 Mission - Return. This project allows the user to send a feedback comment with the features: screenshot, choice of a feedback type, and an amazing text field to provide details about what is happening.

โœจ Technologies

WEB ๐ŸŒ

Server ๐Ÿ–ฅ

Mobile ๐Ÿ“ฑ

๐Ÿ›  Features

  • Allows the user to choose a feedback type (Problem, Idea, or Bug);
  • Allows the user to detail the feedback in a text field;
  • Allows the user to take a screenshot from the screen by clicking a button;
  • After sending the feedback, the user can send another feedback;

โณ ๐Ÿ›  Future Features

  • Switch between light and dark modes;
  • Improve the e-mail HTML/CSS;
  • User authentication (e.g. Firebase);
  • Dashboard containing the user's feedback (by authenticated users only);
  • Add validations and Snackbars with friendly messages to the user;

๐Ÿงช Tests

The application uses unit tests to test the services. All tests are within their context in the __tests__ folder.

๐Ÿš€ Deploy

The chosen deployment platform for the web project was Vercel (Static Deploy and JAMstack, global CDN) and Railway for the server and PostgreSQL instance (Railway is an infrastructure platform where you can provision infrastructure, develop with that infrastructure locally, and then deploy to the cloud.).

โ™ฟ Accessibility (a11y)

Both application (web and mobile) is designed to be fully accessible to users. Navigation can be done entirely through the keyboard and also by screen readers.

๐Ÿ”– Layout

You can take a look at the project layout through this link. You must have an account on Figma website to get access.

๐Ÿ“ License

Copyright ยฉ 2022 Eduardo Klein.
This project is MIT licensed.