Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 1.67 KB

README.md

File metadata and controls

88 lines (70 loc) · 1.67 KB
Raw

md-theme-editor

Overview

Material design theme editor.

Project structure

  • ./src - application
    • ./src/umd - UMD scripts
    • ./src/components - viewless components
    • ./src/views - view components
    • ./src/css - stylesheets (scss files are compiled to application css bundle)
      • ./src/css/main.scss - main application stylesheet
      • ./src/css/vendor.scss - main vendor stylesheet
    • ./src/img - images
  • ./build - temporary build files
  • ./dist - bundled application
  • ./tests - unit tests
  • ./e2e-tests - end to end tests
  • ./config - configuration
    • ./config/os.mk - shell commands
    • ./config/app.mk - variables
    • ./config/deps.mk - custom targets/dependencies
    • ./config/override.js - override dependency package.json

Requirements

Installation

git clone https://github.com/dead-beef/md-theme-editor.git
cd md-theme-editor
make install

Building

# single run
make
# continuous
make watch
# single run, minify
make min
# continuous, minify
make min-watch

Testing

# unit, single run
make test
# unit, continuous
make test-watch
# end to end, single run
make test-e2e
# all, single run
make test-all
# test application bundle
TEST_BUNDLE=1 make test
# select browsers (default: Firefox)
TEST_BROWSERS="Firefox Chrome" make test

Code Linting

make lint

Server

make start
make SERVER_IP=192.168.1.10 SERVER_PORT=1080 start
make stop

Licenses