Phantdom - Rails Database Manager
PostgresSQL database reader made for Ruby on Rails applications.
All logos can be found in
app/assets/images and for release builds inside the
We will try to use "native" UI for each operating system. Default is Mac: http://photonkit.com/components/
Run App 🤯
To run the app you must first have Node installed on computer and NPM.
npm install or
Blank Screen / Node Version Rebuild
Rebuilds native Node.js modules against the version of Node.js that your Electron project is using.
npm run npm-rebuild-electron
This is the electron version of running
npm rebuild to make sure all node modules are compiled under same version.
While the app is running you have access to the Chrome Developer tools. Right click > Inspect Element. Best to have it detached rather than docked.
Note: all NPM modules are being monitored for latest using Dependabot.com
Note: we are running beta of Electron 2.0.0 - https://electronjs.org/releases
The app is loaded in that order, the package.json for Node modules and then the
main.js file loads the main window for the app which is the
app/application.html file which loads up HTML and makes all global variables then loads up
All the events such as Click, Change, etc are handled inside of the
renderer.js file. Each section of the app has it's own directory inside of
events.js file. This is the point of entry after an event into the code for that section.
Example: Once a postgreSQL database table is clicked in sidebar, the renderer file triggers that event on click and then checks events file in
Run Tests 🤩
To run the tests, make sure to learn Mocha, Chai & WebDriver.
- You need PostgreSQL running on machine.
- You need Ruby + Ruby on Rails on machine.
npm run build-rails inside of app directory. This will setup the rails app in which the tests run on.
Run tests with
npm test in terminal.
Build for Mac
npm run build to run using Electron-Builder
Release for Auto-Updater
npm run release to run using Electron-Builder + Upload to S3 which should provide users with new update.
Hound + ESLint
Use an eslint plugin for Atom or Visual Studio code.
Update README.md File
If you add a new function or global variable add it to list in .eslintrc
If you add new NPM modules make sure to run
npm run readme to generate new list in README.md file.
- Install new NPM Packages
- Scripts (build, test, readme, etc)
- Launch status + versions
- npm run start :
- npm run test :
export MOCHA=true; DEBUG=true mocha tests --no-timeouts --bail; unset MOCHA
- npm run eslint :
- npm run npm-rebuild-electron :
- npm run build-rails-db :
cd ruby_on_rails; rake db:create; rake db:migrate; cd ../
- npm run readme :
- npm run build :
- npm run release :
- npm run circleci-test :
mocha tests --reporter mocha-multi-reporters --reporter-options configFile=.mocha-config.json --no-timeouts --bail
- npm run nyan :
export MOCHA=true; DEBUG=true mocha tests --no-timeouts --bail --reporter nyan; unset MOCHA
Automatically monitored for updates by Dependabot.
Copyright 2018 Wynter Jones - https://www.monetizedesign.com
View the License here: https://github.com/MonetizeDesignTeam/phantdom/blob/master/LICENSE.md