README.md

💡 Introduction

Monorepo of Full-stack application Feedback Widget assistant. This project aim to help developers or application's maintainers to get feedback from their users by:

1. Allowing users to leave feedback about Problems, Ideas and Others
2. Getting a user comment about what it's going on
3. Getting a screenshot of application's screen if necessary
4. Submitting user's feedback to application's support via email

🧪 Technologies

Technologies that were used on this application:

• React
• TailwindCSS
• Vite
• TypeScript
• Express
• Prisma
• Jest
• React Native
• Expo

🖥 Pre-requisites:

• NodeJS
• Expo
• Yarn
• Database compatible with Prisma

🚀 How to Run it?

From project's root file:

Web application:

$ cd web
$ yarn install
$ yarn dev

Mobile:

$ cd mobile
$ yarn install
$ yarn start

Backend

$ cd server
$ yarn install

# Run migrations
$ npx prisma migrate dev
$ yarn dev

# Run prisma studio on another console
$ npx prisma studio

⚙️ Environment Variables

Here are some examples of how you can set up your .env files

On Web application:

VITE_API_URL='http://localhost:3333'

On Backend:

DATABASE_URL='postgresql://<username>:<password>@<hostname>:<port>/<database>'

🔖 Layout

Check Figma Layout of this project here

📝 License

MIT License © Yuri Paiva. Check LICENSE for more details

---

Made with 💜  by Yuri Paiva