This Node.js application is designed for web development, integrating scripting, styling, and deployment automation using Gulp, npm, and custom setup scripts.
- Node.js: Ensure Node.js is installed.
- Clone Repository: Clone the project.
-
Dependencies: Run
npm install
to install packages.
- Run
node setup.js
for initial configuration. - Inputs project name, staging URL, and production URL.
- Generates
config.json
,embed-header.txt
, andembed-footer.txt
. -
config.json
contains project settings used by other scripts/tasks.
- Tasks for SCSS, script management, Git integration, and builds.
-
gulp build-prod
: Production build. -
gulp build-staging
: Staging build. - Additional tasks for specific needs.
- The script creates URLs for JavaScript and CSS files hosted on a CDN. These URLs are specific to your project's name and are meant for production and staging environments.
- It also generates embed code for these files and saves them in embed-header.txt and embed-footer.txt. These text files contain HTML code that you can use to easily embed the generated JavaScript and CSS into your webflow pages.
-
npm run setup
: Executes setup script. -
npm test
: Runs tests. -
npm run build
: Default Gulp build. -
npm run build-prod
: Gulp production build. -
npm run build-staging
: Gulp staging build. -
npm start
: Starts default Gulp task. -
npm run deploy
: Deploys and commits changes.
-
debug
: Enables debug mode whentrue
, providing more detailed error messages and logs. -
minify
: Whentrue
, minifies CSS and JS files to reduce file size for production. -
productionLink
: URL of the production environment for deployment. -
stagingLink
: URL of the staging environment for testing before production.
- Use specified gulp tasks for deploying to staging or production.