falcon

(โ˜… 5,097)

Free, open-source SQL client for Windows and Mac ๐Ÿฆ…

  • .babelrc
  • .dockerignore
  • .editorconfig
  • .eslintignore
  • .eslintrc
  • .gitattributes
  • .gitignore
  • .travis.yml
  • app.json
  • appveyor.yml
  • CHANGELOG.md
  • circle.yml
  • CODE_OF_CONDUCT.md
  • CODING_GUIDELINES.md
  • CONTRIBUTING.md
  • Dockerfile
  • EXAMPLES.md
  • LICENSE
  • NEW_CONNECTION.md
  • NEW_RELEASE.md
  • ORACLE.md
  • package.json
  • Procfile
  • README.md
  • webpack.config.base.js
  • webpack.config.electron.js
  • webpack.config.headless.js
  • webpack.config.production.js
  • webpack.config.web.js
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/plotly/falcon

Downloads the entire project code from GitHub to your computer.

cd falcon

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t falcon .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 falcon

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation