README.md

Flask Feedback Form

Flask Feedback Form is a web application designed to collect and analyze feedback and ratings for multiple teams.

Check out the live website here.

Table of Contents

• Features
• Installation
• Usage
• System Architecture
• DBML Diagram
• Credits
• License

Features

• Users can submit feedback for multiple teams by filling out a form with their name, rating, and feedback message.
• Interactive dashboard displaying insights into ratings and feedback that have been submitted.
• Authentication functionality to prevent unauthorized access to the dashboard.

Installation

1. Clone the repository to your local machine.

2. Create a .env file in the root directory with the following data:

   # Application Details
   FEEDBACK_FORM_ADMIN_USERNAME=YOUR_ADMIN_USERNAME
   FEEDBACK_FORM_ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD
   FEEDBACK_FORM_SECRET_KEY=YOUR_SECRET_KEY
   
   # PostgreSQL database details
   FEEDBACK_FORM_DB_HOST=db
   FEEDBACK_FORM_DB_NAME=YOUR_DATABASE_NAME
   FEEDBACK_FORM_DB_USER=YOUR_DATABASE_USERNAME
   FEEDBACK_FORM_DB_PASSWORD=YOUR_DATABASE_PASSWORD
   

3. Build and start the application using Docker Compose:

   docker-compose up --build

Usage

• Visit http://localhost:3000/ to submit feedback.
• Visit http://localhost:3000/dashboard to view data.

System Architecture

DBML Diagram

Credits

This project was created by Nishith P Shetty and Bhuvan S A.

License

This project is licensed under the terms of the GNU GENERAL PUBLIC LICENSE.