Franchise is a lightweight but powerful SQL tool that provides an intuitive notebook interface for users. It allows easy interaction with SQL databases without the need for sign-ups or installations. In this blog, we will walk you through how to get started with Franchise, how to run it locally, troubleshoot common issues, and ultimately enhance your data querying experience!

Why Choose Franchise?

• No sign-up or installation required—just access franchise.cloud!
• Directly edit CSV, JSON, and XLSX files using integrated tools like js-xlsx and sql.js.
• Connect effortlessly to databases such as PostgreSQL, MySQL, or BigQuery with a single terminal command.
• Visualize data with easy charting and side-by-side query comparisons.
• Utilize our unique notebook layout engine for a customizable experience.

How to Run Franchise Locally (Development Mode)

To start using Franchise locally, you’ll want to follow these simple steps:

1. If you don’t have npm or yarn, install yarn.
2. Open a terminal and run the following command to clone the Franchise repository:

git clone --depth 1 https://github.com/HVF/franchise.git

3. Change into the project directory:

cd franchise

4. Install the project dependencies:

yarn install

5. Start the development server:

yarn start

6. Open your browser and go to http://localhost:3000.
7. Edit files in the franchise/src directory. The browser will reload automatically when you save your edits.
8. (Optional) Consider adding functionalities and sending a Pull Request (PR)!

Running Franchise using Docker

If you prefer to use Docker, follow these steps:

Using Docker Hub Image

docker run \
    --name franchise \
    -p 3000:80 \
    -p 14645:14645 \
    -d binakot/franchise

Building Your Own Docker Image

1. Build a docker image:

docker build -t franchise .

2. Run a container with the image:

docker run \
    --name franchise \
    -p 3000:80 \
    -p 14645:14645 \
    -d franchise

Creating an Electron App

You can also build an Electron app for various operating systems using the following commands:

• Linux: yarn build:electron:linux
• macOS: yarn build:electron:mac
• Windows: yarn build:electron:windows

After building, check the dist folder for the application.

Troubleshooting Common Issues

• If you’re having trouble running the project: Make sure you’ve correctly installed all dependencies and that you’re using the right terminal commands. Check your connection to your local database.
• Browser not loading: Ensure that your development server is running and that you’re accessing the correct URL http://localhost:3000.
• Docker Issues: If you’re encountering issues with Docker, verify your Docker installation and check that the necessary ports are available.
• For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

Franchise offers an impressive toolkit for those looking to manage their SQL databases without the hassle of setups or detailed configurations. Whether you wish to run it locally or within a Docker container, the process is straightforward and user-friendly.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.