ad-insertion v0.0.3

ad-insertion

Contributing

Write access to the GitHub repository is restricted, so make a fork and clone that. All work should be done on its own branch, named according to the issue number (e.g. 42 or bug/23). When you are finished with your work, push your feature branch to your fork, preserving branch name (not to master), and create a pull request.

This project uses several submodules, so please be sure to keep everything updated and not make changes to any submodules (unless you are contributing directly to those projects).

Update using:

• git pull upstream master
• git submodule update --init --recursive

Bundle/package/minify resources using:

Please see NPM scripts if you're using Node, as alternative and easier methods are provided via scripts

• JavaScript - webpack
• CSS - myth stylesheets/styles/import.css -c stylesheets/styles/styles.css

Contact

• Issues
• Chat
• Email

PHP developer notes

This project uses PHP's native autoloader, which is configured via .travis.yml and .htaccess environment variables. Apache will automatically include the autoloader script using php_value auto_prepend_file, but since this uses relative paths, it will only work correctly in the project's root directory. To use in other directories, place a .htaccess and set the relative path accordingly.

JavaScript developer notes

Due to Content-Security-Policy, use of eval and inline scripts are prohibited. Further, this project uses ECMAScript 2015 modules, so be sure to familiarize yourself with the syntax.

CSS developer notes

Like in the above, one of the goals of this project is to keep things working natively, which means standardized CSS and JavaScript. Although the features may be new, import and export in JavaScript, and @import and --var-name: value are official standards. In the case of CSS, browser support does exist, and so this project will use @import and CSS variables in favor of SASS or LESS.

Git submodules

• shgysk8zer0/core_api
• shgysk8zer0/core
• shgysk8zer0/dom
• shgysk8zer0/std-js
• shgysk8zer0/core-css
• shgysk8zer0/fonts
• shgysk8zer0/svg-icons
• shgysk8zer0/logos
• github/octicons
• necolas/normalize.css

Dev dependencies

• Myth
• Babel
• Webpack
• ESLint

npm install "myth" "babel-loader" "babel-core" "babel-preset-es2015" "webpack" "eslint"