Frontend for Q-gpt

This project aims to solve the cumbersome and time-consuming process of data retrieval from databases by providing a chatbot-like interface to query in English for faster and more reliable responses.

Table of Contents

• Overview
• Features
• Installation
• Configuration
• Usage
• Contributing
• Help

Overview

The backend of Q-gpt is built using Node.js and Express. It provides API endpoints for user authentication, file uploads, and data processing. The backend interacts with Firebase for user management and data storage.

Features

• User authentication (Sign Up, Login, Google Sign-In)
• File upload handling with support for JSON and CSV files
• Data processing and storage using Firebase Realtime Database
• Secure authentication with Firebase Admin SDK

Installation

Clone the repository:

  git clone https://github.com/yourusername/q-gpt-backend.git
  cd q-gpt-backend

2. Install dependencies:

   npm i

Configuration

1. Create a .env file in the root directory and add the following environment variables:

   PORT = 3000
   DATABASE_URL=your-database-url (We used firebase realtime db)
   WEBKEY_API=your-webkey-api
   RAPIDAPI_KEY=your-rapidapi-key

2. Create a firebaseConfig.json file in the root directory and add your configurations

Usage

1. Start the development server :

   npm run start

2. You'll have to run the frontend to access the application . (url for backend : https://github.com/KniteenK/Q-gpt-frontend)

Contribution

If you want to contribute to this project, please fork the repository and create a pull request with your changes. Ensure that you follow the coding standards and provide appropriate tests.

Help

If you have any suggestion , feedback or anything you want to say in general , you can reach out to me via email : [email protected]