BaseJSGulp

QuickBase automatic build system

What is gulp?

gulp is a toolkit that will help you automate painful or time-consuming tasks in your development workflow. For web development (if that's your thing) it can help you by doing CSS preprocessing, JS transpiling, minification, live reloading, and much more.

Here is a helpful, simple article on getting started with gulp. Getting Started with Gulp

What is BaseJSGulp?

BaseJSGulp utilizes gulp and its plugins to automate and enhance the development workflow for QuickBase. These automated tasks currently include but are not limited to:

• Automatically execute common tasks on change("gulp watch") or by deployment command("gulp deploy").
• Minify JS and CSS.
• Namespace and upload files to QuickBase app including the git repo url at the top of each page.
• Compile SCSS to CSS.
• Compile JSX to JS.
• Convert ES6 to ES5.
• Automatically commit and push to git repo.
• Automatically add README.md including name, description, client and authors of application.

Setup new project

• Create new repo.
• Clone 'BaseJSGulp' repo.

git clone https://github.com/AdvantageIntegratedSolutions/BaseJSGulp.git <NEW APP NAME>

• Replace the git origin remote with your new repo's git url.

git remote set-url origin <new repo git url>

• Fill out app.json.

{
  "name": "Time Tracker", //name of new app
  "description": "Simple daily time tracker app", //short description of app
  "client": "Coca-Cola", //client name
  "realm": "ais", //quickbase realm
  "dbid": "bkb4gyte3", //quickbase main db
  "username": "uSeRnAmE", //quickbase username
  "password": "pAsSwOrD", //quickbase password
  "token": "8t82d3b3sxnfxiu2pbepcjfd", //quickbase app token
  "origin": "https://github.com/AdvantageIntegratedSolutions/<NEW APP NAME>.git", //url of new repo
  "jsBundlePrefix": "main", //compiled file prefix for JS
  "cssBundlePrefix": "styles", //compiled file prefix for CSS
  "authors": ["[email protected]"] //list of authors
}

**Set the "GULPPASSWORD" ENV variable to avoid committing password. Simply keep the password value empty in app.json or remove it.

sudo vi ~/.bash_profile; export GULPPASSWORD=>PASSWORD;

• run "npm install"
• run "gulp init"

How to use

To start automating tasks, run the following commands within your app:

• "gulp deploy" - if you want to run your tasks periodically, run "gulp deploy" and it will execute all deployment tasks.

• "gulp watch" - if you want to run your tasks each time you make a change to your app, run "gulp watch" in your terminal and it will execute all deployment tasks as you work in your app.

Enable Notifications

Allow mac alerts when tasks are finished(i.e. everything is synced) by enabling notifications. System Preferences > Notifications > terminal-notifier