🚀 Feedget 🚀

Project | Technologies | Features | Getting started | License

💻 Project

API 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

Web version: Feedback Widget (Web)

Mobile version: Feedback Widget (Mobile)

🚀 Technologies

• Node.js
• Typescript
• Express
• Prisma
• Jest
• Nodemailer

🛠 Features

✔️ Send text feedback

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

✔️ Automatic emailing to website/app owner

✔️ 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-api.git && cd feedback-widget-api

Follow the steps below

Server

# Install the dependencies
$ npm install

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env

# With a PostgreSQL running, run the migrations
$ npx prisma migrate dev

# Start the server
$ npm run dev

To test the full application

After running the server you must run the web version (Feedback Widget (Web)) or/and the mobile version (Feedback Widget (Mobile))

📝 License

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

---

Made with ❤️ by Lucca Di Bastiani