This documentation is WIP.
Cuckoo makes use of Gulp to build from source to static (frontend sources). Before you can use this, make sure that the following dependencies are installed (required for Node and following assets):
On a Debian based system the package requirements are:
apt-get install build-essential curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash - sudo apt-get install nodejs sudo npm install gulp -g sudo apt-get install ruby-full rubygems sudo gem update --system sudo gem install sass npm install # At this point the required libs are installed. # Run the following command to build new JS and CSS: gulp build
After these packages have been installed, navigate to the source folder (cd cuckoo/web/src) and run npm install. This will install all node modules as listed in package.json. After this you should be good to go!
While in the cuckoo/web/src directory (or the directory where package.json is located) you can run the following commands:
- runs build processes and starts watcher
gulp buildOR npm run-script build
- build source to static ONCE.
- only runs the ‘styles’ task (compiles SCSS to static/css)
Try modifying one of the
.js files in the
Creating new tasks¶
A gulp module in its basic form looks like this: