FeedAI

Welcome to my repository for Team-1/FeedAI.

Introduction

It is a website where you will import a .csv file with feedback from your customers and our trained AI model will perform an analysis showing metrics of positive, neutral and negative feedbacks.

Created to participate in the Borderless Coding Hackathon

The PostgreSQL database is securely deployed on Render, ensuring high availability and scalability.

If you want to test, please use the CSV templates that are in this repository.

Table of Contents

• Introduction
• Key Features
• Technologies Used
• Installation
• Deployed Version
• What's Coming Up
• Conclusion

Key Features

• Csv Import
• Csv Analysis
• Data Metrics

Technologies Used

Back-end:

• PostgreSQL
• Fast API
• Python3

Front-end:

• React
• Axios
• TypeScript
• Framer Motion
• Shadcn
• Context API
• Tailwind CSS
• Zustand
• React Query

Installation

Before you start, ensure you have node, npm, docker and python installed on your machine.

Clone the repository:

git clone https://github.com/ProgramadoresSemPatria/Team-1.git

Backend setup:

1. Navigate to the repository:

   cd backend

2. Set up docker:

   docker compose up -d

3. Check if containers are running properly:

   docker ps

4. Set up local env:

    python3 -m venv venv

5. Activate local env:

   (windows)
    .\venv\Scripts\activate
   
   (mac/linux)
   .\venv\Scripts\activate

6. Install the dependencies:

   pip install -r requirements.txt

7. Set up .env file

8. Run backend:

   uvicorn api.main:app --reload

Frontend Setup

1. Navigate to the repository:

   cd frontend

2. Install the dependencies:

   npm install

3. Run frontend:

   npm run dev

Deployed Version

You can also visit the deployed version of the application here.

Conclusion

This project demonstrates the powerful combination of modern front-end and back-end technologies, with a strong focus on user experience, usability, and data management. Thank you for exploring the project! I welcome contributions and feedback to help enhance its capabilities further.

---

If you find any bugs or have a feature request, please open an issue on GitHub.