Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HVF/franchise
🍟 a notebook sql client. what you get when have a lot of sequels.
https://github.com/HVF/franchise
bigquery database mysql postgresql sql
Last synced: about 1 month ago
JSON representation
🍟 a notebook sql client. what you get when have a lot of sequels.
- Host: GitHub
- URL: https://github.com/HVF/franchise
- Owner: HVF
- License: mit
- Created: 2017-08-01T17:40:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T20:04:54.000Z (about 2 years ago)
- Last Synced: 2024-10-29T15:47:48.267Z (about 1 month ago)
- Topics: bigquery, database, mysql, postgresql, sql
- Language: JavaScript
- Homepage: https://franchise.cloud
- Size: 1.96 MB
- Stars: 4,009
- Watchers: 102
- Forks: 262
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - franchise - 🍟 a notebook sql client. what you get when have a lot of sequels. (JavaScript)
- jimsghstars - HVF/franchise - 🍟 a notebook sql client. what you get when have a lot of sequels. (JavaScript)
README
# Franchise
*a sql notebook*
Franchise is a lightweight but powerful SQL tool with a notebook interface. You can use it online at [franchise.cloud](https://franchise.cloud).
[](https://franchise.cloud)
- There's no **sign up** and **no install**
- For editing CSVs, JSON, XLSX files, we've integrated [js-xlsx](https://github.com/SheetJS/js-xlsx), and [sql.js](https://github.com/kripken/sql.js/) so you can query data entirely locally in your browser
- For connecting to **PostgreSQL**, **MySQL**, or **BigQuery**, just run a single command in your terminal to open a bridge that allows Franchise to directly connect to your database. Your data never touches a third party server.
- Chart with a single click
- Compare queries side by side
- With our [unique notebook layout engine](https://github.com/antimatter15/breadloaf), you can drag and drop cells on the same line to compare views.
# Running Locally (Development Mode)
There's an online version of franchise [right here](https://franchise.cloud). There are also instructions for building franchise to static files [here](https://github.com/HVF/franchise/blob/master/DEPLOYING_LOCALLY.md).
Otherwise, here's how to run franchise in development mode:
0. **If you don't have `npm` or `yarn`, install** [yarn](https://yarnpkg.com/en/docs/install).
1. **Open up a terminal and run**
```bash
git clone --depth 1 https://github.com/HVF/franchise.git
```
2. **cd into the project directory**
```bash
cd franchise
```
3. **Install the project dependencies**
```bash
yarn install
```
(you can also run `npm install`)
4. **Start the dev server**
```bash
yarn start
```
(you can also run `npm start`)
5. **Open up a browser and go to** `http://localhost:3000`
6. **Edit some files in `franchise/src`.**
When you save your edits, and the browser will automatically reload.
7. (optional) **Add a bunch of great functionality and send a PR!**
---
# Running in Docker 🐳
Application will be available here: [http://localhost:3000](http://localhost:3000)
## Using Docker Hub image
```bash
docker run \
--name franchise \
-p 3000:80 \
-p 14645:14645 \
-d binakot/franchise
```
## Build your own image
0. Build a docker image:
```bash
docker build -t franchise .
```
1. Run a container with image:
```bash
docker run \
--name franchise \
-p 3000:80 \
-p 14645:14645 \
-d franchise
```
---
# Build electron app
Linux:
```bash
yarn build:electron:linux
```
macOS:
```bash
yarn build:electron:mac
```
Windows:
```bash
yarn build:electron:windows
```
After build check out `dist` folder.