{"id":13467600,"url":"https://github.com/HVF/franchise","last_synced_at":"2025-03-26T03:30:46.446Z","repository":{"id":38418372,"uuid":"99027562","full_name":"HVF/franchise","owner":"HVF","description":"🍟 a notebook sql client. what you get when have a lot of sequels.","archived":false,"fork":false,"pushed_at":"2022-12-10T20:04:54.000Z","size":2055,"stargazers_count":4009,"open_issues_count":61,"forks_count":262,"subscribers_count":102,"default_branch":"master","last_synced_at":"2024-10-29T15:47:48.267Z","etag":null,"topics":["bigquery","database","mysql","postgresql","sql"],"latest_commit_sha":null,"homepage":"https://franchise.cloud","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HVF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-01T17:40:56.000Z","updated_at":"2024-10-29T12:59:35.000Z","dependencies_parsed_at":"2023-01-26T10:00:38.462Z","dependency_job_id":null,"html_url":"https://github.com/HVF/franchise","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HVF%2Ffranchise","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HVF%2Ffranchise/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HVF%2Ffranchise/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HVF%2Ffranchise/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HVF","download_url":"https://codeload.github.com/HVF/franchise/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222107287,"owners_count":16932450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bigquery","database","mysql","postgresql","sql"],"created_at":"2024-07-31T15:00:58.366Z","updated_at":"2024-10-29T20:30:38.864Z","avatar_url":"https://github.com/HVF.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://franchise.cloud/app\"\u003e\n    \u003cimg src=\"https://i.imgur.com/RmMphMl.png\" width='270'/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# Franchise\n*a sql notebook*\n\n\nFranchise is a lightweight but powerful SQL tool with a notebook interface. You can use it online at [franchise.cloud](https://franchise.cloud).\n\n[![Franchise is pretty cool](https://franchise.cloud/images/landing-gif.gif)](https://franchise.cloud)\n\n- There's no **sign up** and **no install**\n    - 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\n    - 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.\n- Chart with a single click\n- Compare queries side by side\n    - With our [unique notebook layout engine](https://github.com/antimatter15/breadloaf), you can drag and drop cells on the same line to compare views.\n    \n# Running Locally (Development Mode)\nThere'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).\n\nOtherwise, here's how to run franchise in development mode:\n\n0. **If you don't have `npm` or `yarn`, install** [yarn](https://yarnpkg.com/en/docs/install).\n\n1. **Open up a terminal and run**\n\n    ```bash\n    git clone --depth 1 https://github.com/HVF/franchise.git\n    ```\n\n2. **cd into the project directory**\n    ```bash\n    cd franchise\n    ```\n\n3. **Install the project dependencies**\n    ```bash\n    yarn install\n    ```\n\n    (you can also run `npm install`)\n\n4. **Start the dev server**\n    ```bash\n    yarn start\n    ```\n\n    (you can also run `npm start`)\n\n5. **Open up a browser and go to** `http://localhost:3000`\n\n6. **Edit some files in `franchise/src`.**\n    \n    When you save your edits, and the browser will automatically reload.\n\n7. (optional) **Add a bunch of great functionality and send a PR!**\n\n---\n\n# Running in Docker 🐳\n\nApplication will be available here: [http://localhost:3000](http://localhost:3000)\n\n## Using Docker Hub image\n\n```bash\ndocker run \\\n    --name franchise \\\n    -p 3000:80 \\\n    -p 14645:14645 \\\n    -d binakot/franchise\n```\n\n## Build your own image\n\n0. Build a docker image:\n\n```bash\ndocker build -t franchise .\n```\n\n1. Run a container with image:\n\n```bash\ndocker run \\\n    --name franchise \\\n    -p 3000:80 \\\n    -p 14645:14645 \\\n    -d franchise\n```\n\n---\n\n# Build electron app\n\nLinux: \n\n```bash\nyarn build:electron:linux\n```\n\nmacOS: \n\n```bash\nyarn build:electron:mac\n```\n\nWindows: \n\n```bash\nyarn build:electron:windows\n```\n\nAfter build check out `dist` folder.\n","funding_links":[],"categories":["JavaScript","awesomeMe"],"sub_categories":["Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHVF%2Ffranchise","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHVF%2Ffranchise","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHVF%2Ffranchise/lists"}