Feedback Widget - FeedGet

Project • Layout • Technologies • Getting started • Roadmap • License

Project

Web and App Mobile version of a component responsible for sending feedbacks of an application. The feedbacks are composed of a message and a optional screenshot, which can be taken automatically. These are saved on a database and also sent via email.

This project was developed as a study case on Rocketseat's NLW #8 event.

Layout

The project layout is available at the link below:

• Feedback Widget - Figma

Setup a Figma account to access and duplicate it, if you wish to.

Technologies

• ReactJS
• TypeScript
• TailwindCSS
• Vitejs
• Express
• Prisma
• React Native
• Expo

Getting started

Requirements

• Node.js
• Yarn or npm
• Docker
• Expo CLI

Clone the project and access the folder

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

Follow the steps below

Server

# From the project root folder access the 'server' folder
$ cd server

# Install the dependencies
$ npm install

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

# Start a Postgres instance on Docker
$ docker run --name feedget-postgres \
    -e POSTGRES_USER=docker -e POSTGRES_PASSWORD=docker123 \
    -e POSTGRES_DB=feedget -p 5432:5432 -d postgres

# Run the migrations
$ npx prisma migrate dev

# Start the server
$ npm run dev

Web

Make sure to have the server running

# From the project root folder access the 'web' folder
$ cd web

# 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

Mobile

Make sure to have the server running

# From the project root folder access the 'mobile' folder
$ cd mobile

# Install the dependencies
$ npm install

# Start the bundle
$ expo start

# Connect your phone or start a emulator

License

This project is distributed under the MIT License. See the LICENSE file for more details.