Inquiro Text-To-SQL

Introduction

This is a repository for the Inquiro Text-To-SQL project. The goal of this project is to create a system that can take a natural language question and convert it into a SQL query that can be run on a database. This project is being developed by a team of students at International School of Engineering (ISE) at Chulalongkorn University as a part of Robotics & AI Senior Project course.

Installation

Prerequisites

This project requires the following software to be installed on your system:

Linux, macOS, or WSL (Windows is not supported)
Bun

Please note that this project mainly utilizes Bun capabilities. This means that other package managers such as npm and yarn are not supported.

Set up Develpment Server

Clone this repository:

git clone git@github.com:Robotics-AI-Project/Inquiro-Frontend-v3.git

Copy the .env.tempalte file to .env.local:

cp .env.tempalte .env.local

and fill in the required values.

Install the dependencies:

bun install

Run the development server:

bun dev

You'll be able to access the development server at http://localhost:3000.
You'll also be able to access Swagger UI at http://localhost:3000/api/swagger.

Project Structure Overview

This repository contains both frontend and backend code. Please refer to the following files for further explaination of the project structure: