diff --git a/.gitignore b/.gitignore index 0f8ac72..a7636f8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,11 @@ -.sass-cache +### OSX ### +.DS_Store + +### PhPStorm / IntellJ IDEA ### +.idea/ +*.iml + +### Misc ### node_modules/ *.map +.sass-cache \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c8cc07a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## How to contribute to Web Maker + +Web Maker is written in vanilla JavaScript, CSS & HTML. It uses few open-source 3rd party JavaScript libraries for things like splitting panes, syntax highlighting etc. There is no build process involved in running Web Maker on your local system. + +### Run Web Maker locally on your machine + +- Clone the repo `git clone git@github.com:chinchang/web-maker.git`. +- Go to Chrome extension settings page [chrome://extensions/](chrome://extensions/). +- Click on **Load unpacked extension** button. +- Select the `src` folder in the repo you just cloned. +- Done! You'll now have a Web Maker icon added in your browser's right-top area. Click that and you'll run your local copy of Web Maker. + +### Code changes + +- Before starting any code work, run `npm install` in the repo folder. This is required to install some git hooks which do linting & formatting. +- Also, create a new branch out of master branch with the name as `fix-{ISSUE_ID}-anything-more-here`. For example, if you are working on issue #23 regarding implementing a mobile mode, your branch could be called `fix-23-mobile-mode`. +- Now you can simply make code changes inside `src/` folder and refresh in browser to see them. +- Once you are done, open a pull request here by selecting right branch: [https://github.com/chinchang/web-maker/compare](https://github.com/chinchang/web-maker/compare). \ No newline at end of file diff --git a/README.md b/README.md index 5150e8a..76a60e6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Web-Maker ![Build](https://travis-ci.org/chinchang/web-maker.svg?branch=master) * Works offline * Inbuilt Console * Save and load your creations -* Auto-save feture +* Auto-save feature * Code auto-completion * Easy addition of popular JS & CSS libraries * Import & Export all creations anytime, anywhere diff --git a/git-hooks/pre-commit b/git-hooks/pre-commit index c819412..b4446ae 100755 --- a/git-hooks/pre-commit +++ b/git-hooks/pre-commit @@ -11,7 +11,7 @@ jsfiles=$(git diff --staged --name-only --diff-filter=ACM | grep '\.js$') [ -z "$jsfiles" ] && exit 0 # ESLINT CHECK -eslintresult=$(./node_modules/.bin/eslint --color $jsfiles) +eslintresult=$(./node_modules/.bin/eslint --ignore-pattern '/src/lib/*' --color $jsfiles --quiet) if [[ $eslintresult != "" ]]; then echo "$eslintresult" diff --git a/package.json b/package.json index cb238ca..a963c8b 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "prettier": "^1.5.2" }, "scripts": { - "install": "ln -s ../../git-hooks/pre-commit .git/hooks/pre-commit" + "install": "ln -sf ../../git-hooks/pre-commit .git/hooks/pre-commit" }, "repository": { "type": "git", diff --git a/src/changelog.html b/src/changelog.html index 4b8c9ce..25bbbf4 100644 --- a/src/changelog.html +++ b/src/changelog.html @@ -1,17 +1,47 @@ + + + + + +

Whats new?

+
+ 2.9.3 + +
+ +
+ 2.9.2 + +
+ +
2.9.1
diff --git a/src/index.html b/src/index.html index c002161..d199c19 100644 --- a/src/index.html +++ b/src/index.html @@ -49,7 +49,7 @@ Run - + Add library @@ -216,7 +216,7 @@ - + @@ -226,7 +226,7 @@ © Web Maker    - + @@ -243,6 +243,11 @@