Skip to content

Azaken1248/AzaSQL

Repository files navigation

AzaSQL

AzaSQL is a web-based SQL terminal and simulator designed to provide an interactive environment for executing SQL commands directly in the browser. It features a terminal-like interface, syntax highlighting, and integrates with AI for an enhanced user experience.

Features

  • SQL in the Browser: Execute SQL queries and commands directly in your web browser using sql.js.
  • Terminal Interface: The application provides a full-featured terminal powered by xterm.js for a familiar command-line experience.
  • Syntax Highlighting: Code syntax is highlighted using prismjs to improve readability.
  • Interactive Code Editor: An easy-to-use code editor is provided by react-simple-code-editor.
  • Dependencies: The project also includes firebase for backend services and axios for API calls.

Tech Stack

  • Frontend: React, TypeScript, and Vite
  • Styling: TailwindCSS
  • SQL Engine: sql.js
  • Terminal: xterm and xterm-addon-fit
  • API Calls: axios
  • Backend Services: Firebase

Getting Started

To set up the project locally, follow these steps.

Prerequisites

Make sure you have Node.js installed on your machine.

Installation

  1. Clone the repository:
    git clone [https://github.com/azaken1248/azasql.git](https://github.com/azaken1248/azasql.git)
    cd azaken1248/azasql/AzaSQL-c63a54636169905580ba7edeaa3a5bbacff81af0/
  2. Install the dependencies using npm or pnpm:
    npm install
    # or
    pnpm install

Running the Project

To start the development server:

npm run dev

This will run the app in development mode. Open http://localhost:5173 to view it in your browser.

Building the project

npm run build

This command builds the app for production to the dist folder.

Contributing

Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

License

This project is licensed under the MIT License.

About

A Online Frontend-First Lightweight SQL Client.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published