Added README and LICENSE.

astrofox-io · Oct 7, 2020 · 4b1ef58 · 4b1ef58
1 parent a769113
commit 4b1ef58
Show file tree

Hide file tree

Showing 28 changed files with 164 additions and 14 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Mike Cao <mike@mikecao.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,46 @@
+# Astrofox
+
+## What is it?
+
+Astrofox is a motion graphics program that lets you create music visualizations and turn them into videos.
+
+## Quick links
+
+- Website: https://astrofox.io
+- Discord chat: https://discord.gg/wJ6pyMZ
+- Reddit forum: https://www.reddit.com/r/astrofox/
+- Bug tracker: https://github.com/astrofox-io/astrofox/issues
+
+## Running Astrofox
+
+### Get the source
+
+```
+git clone https://github.com/astrofox-io/astrofox.git
+```
+
+### Install FFmpeg
+
+Create a `bin` folder in the project and place a copy of the [ffmpeg](https://ffmpeg.org/) binary for your OS.
+
+
+### Install dependencies
+
+```
+yarn install
+```
+
+### Start development server
+
+```
+yarn dev
+```
+
+### Start Electron
+```
+yarn start
+```
+
+## License
+
+MIT
diff --git a/package.json b/package.json
@@ -1,23 +1,27 @@
 {
   "name": "astrofox",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "main": "app/main.js",
   "productName": "Astrofox",
-  "description": "Turn music visualizations into videos",
+  "description": "Audio reactive motion graphics program",
   "author": "Mike Cao <mike@mikecao.com>",
   "homepage": "https://astrofox.io",
-  "private": true,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/astrofox-io/astrofox"
+  },
   "scripts": {
-    "start": "cross-env PORT=3000 electron ./app",
-    "dev": "webpack-dev-server --port 3000 --progress --colors --config webpack.config.view.js",
-    "dev-electron": "webpack --progress --watch --config webpack.config.electron.js",
+    "start": "dotenv electron ./app",
+    "dev": "npm-run-all dev-electron dev-view",
+    "dev-view": "dotenv webpack-dev-server --progress --colors --config webpack.config.view.js",
+    "dev-electron": "dotenv webpack --progress --watch --config webpack.config.electron.js",
     "build-dev": "webpack --progress --config webpack.config.js",
     "build-prod": "cross-env NODE_ENV=production webpack --progress --config webpack.config.js",
     "build-main": "webpack --config webpack.config.main.js",
     "build-preload": "webpack --config webpack.config.preload.js",
-    "build-win": "electron-builder --x64 --win",
-    "build-mac": "electron-builder --x64 --mac",
-    "build-linux": "electron-builder --x64 --linux",
+    "build-win": "dotenv electron-builder --x64 --win",
+    "build-mac": "dotenv electron-builder --x64 --mac",
+    "build-linux": "dotenv electron-builder --x64 --linux",
     "lint": "eslint src || exit 0",
     "lint-fix": "eslint --fix src || exit 0",
     "lint-check": "eslint --print-config . | eslint-config-prettier-check",
@@ -36,7 +40,7 @@
     ],
     "extraResources": [
       {
-        "from": "resources/ffmpeg/${os}/${arch}",
+        "from": "resources/ffmpeg/${os}",
         "to": "bin"
       }
     ],
@@ -127,6 +131,7 @@
     "cross-env": "^7.0.2",
     "css-loader": "^3.5.3",
     "dotenv": "^8.2.0",
+    "dotenv-cli": "^4.0.0",
     "electron": "^8.3.0",
     "electron-builder": "^22.6.1",
     "electron-notarize": "^1.0.0",
@@ -148,6 +153,7 @@
     "less-loader": "^6.1.0",
     "lint-staged": "^10.2.4",
     "mini-css-extract-plugin": "^0.9.0",
+    "npm-run-all": "^4.1.5",
     "optimize-css-assets-webpack-plugin": "^5.0.3",
     "prettier": "^2.0.5",
     "prettier-eslint": "^10.1.0",

diff --git a/src/build/app/package.json b/src/build/app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "astrofox",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "main": "main.js",
   "productName": "Astrofox",
   "description": "Astrofox",

diff --git a/src/main/window.js b/src/main/window.js
@@ -12,6 +12,7 @@ import {
   WINDOW_BGCOLOR,
 } from './constants';
 
+const PORT = process.env.PORT || 3000;
 const log = debug('window');
 
 let win = null;
@@ -114,7 +115,7 @@ export function createWindow() {
           protocol: 'file',
           slashes: true,
         })
-      : `http://localhost:${process.env.PORT}`,
+      : `http://localhost:${PORT}`,
   );
 
   // Show window only when ready

diff --git a/src/view/shaders/BarrelBlurShader.js → src/shaders/BarrelBlurShader.js b/src/view/shaders/BarrelBlurShader.js → src/shaders/BarrelBlurShader.js
diff --git a/src/view/shaders/BlendShader.js → src/shaders/BlendShader.js b/src/view/shaders/BlendShader.js → src/shaders/BlendShader.js
diff --git a/src/view/shaders/BoxBlurShader.js → src/shaders/BoxBlurShader.js b/src/view/shaders/BoxBlurShader.js → src/shaders/BoxBlurShader.js
diff --git a/src/view/shaders/CircularBlurShader.js → src/shaders/CircularBlurShader.js b/src/view/shaders/CircularBlurShader.js → src/shaders/CircularBlurShader.js
diff --git a/src/view/shaders/ColorShiftShader.js → src/shaders/ColorShiftShader.js b/src/view/shaders/ColorShiftShader.js → src/shaders/ColorShiftShader.js
diff --git a/src/view/shaders/CopyShader.js → src/shaders/CopyShader.js b/src/view/shaders/CopyShader.js → src/shaders/CopyShader.js
diff --git a/src/view/shaders/DepthShader.js → src/shaders/DepthShader.js b/src/view/shaders/DepthShader.js → src/shaders/DepthShader.js
diff --git a/src/view/shaders/DotScreenShader.js → src/shaders/DotScreenShader.js b/src/view/shaders/DotScreenShader.js → src/shaders/DotScreenShader.js
diff --git a/src/view/shaders/FXAAShader.js → src/shaders/FXAAShader.js b/src/view/shaders/FXAAShader.js → src/shaders/FXAAShader.js
diff --git a/src/view/shaders/GaussianBlurShader.js → src/shaders/GaussianBlurShader.js b/src/view/shaders/GaussianBlurShader.js → src/shaders/GaussianBlurShader.js
diff --git a/src/view/shaders/GlowShader.js → src/shaders/GlowShader.js b/src/view/shaders/GlowShader.js → src/shaders/GlowShader.js
diff --git a/src/view/shaders/GridShader.js → src/shaders/GridShader.js b/src/view/shaders/GridShader.js → src/shaders/GridShader.js
diff --git a/src/view/shaders/HalftoneShader.js → src/shaders/HalftoneShader.js b/src/view/shaders/HalftoneShader.js → src/shaders/HalftoneShader.js
diff --git a/src/view/shaders/HexagonShader.js → src/shaders/HexagonShader.js b/src/view/shaders/HexagonShader.js → src/shaders/HexagonShader.js
diff --git a/src/view/shaders/LEDShader.js → src/shaders/LEDShader.js b/src/view/shaders/LEDShader.js → src/shaders/LEDShader.js
diff --git a/src/view/shaders/LuminanceShader.js → src/shaders/LuminanceShader.js b/src/view/shaders/LuminanceShader.js → src/shaders/LuminanceShader.js
diff --git a/src/view/shaders/MirrorShader.js → src/shaders/MirrorShader.js b/src/view/shaders/MirrorShader.js → src/shaders/MirrorShader.js
diff --git a/src/view/shaders/PixelateShader.js → src/shaders/PixelateShader.js b/src/view/shaders/PixelateShader.js → src/shaders/PixelateShader.js
diff --git a/src/view/shaders/PointShader.js → src/shaders/PointShader.js b/src/view/shaders/PointShader.js → src/shaders/PointShader.js
diff --git a/src/view/shaders/RGBShiftShader.js → src/shaders/RGBShiftShader.js b/src/view/shaders/RGBShiftShader.js → src/shaders/RGBShiftShader.js
diff --git a/src/view/shaders/ZoomBlurShader.js → src/shaders/ZoomBlurShader.js b/src/view/shaders/ZoomBlurShader.js → src/shaders/ZoomBlurShader.js
diff --git a/webpack.config.view.js b/webpack.config.view.js
@@ -7,6 +7,7 @@ const TerserPlugin = require('terser-webpack-plugin');
 const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
 
 const PRODUCTION = process.env.NODE_ENV === 'production';
+const PORT = process.env.PORT || 3000;
 
 module.exports = {
   mode: PRODUCTION ? 'production' : 'development',
@@ -16,6 +17,7 @@ module.exports = {
     app: path.resolve(__dirname, 'src/view/index.js'),
   },
   devServer: {
+    port: PORT,
     hotOnly: true,
     historyApiFallback: true,
   },

diff --git a/yarn.lock b/yarn.lock
@@ -3298,12 +3298,22 @@ dot-prop@^5.2.0:
   dependencies:
     is-obj "^2.0.0"
 
+dotenv-cli@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/dotenv-cli/-/dotenv-cli-4.0.0.tgz#3cdd68b87ccd63c78dbfa72aab2f639bbeba5f4b"
+  integrity sha512-ByKEec+ashePEXthZaA1fif9XDtcaRnkN7eGdBDx3HHRjwZ/rA1go83Cbs4yRrx3JshsCf96FjAyIA2M672+CQ==
+  dependencies:
+    cross-spawn "^7.0.1"
+    dotenv "^8.1.0"
+    dotenv-expand "^5.1.0"
+    minimist "^1.1.3"
+
 dotenv-expand@^5.1.0:
   version "5.1.0"
   resolved "https://registry.yarnpkg.com/dotenv-expand/-/dotenv-expand-5.1.0.tgz#3fbaf020bfd794884072ea26b1e9791d45a629f0"
   integrity sha512-YXQl1DSa4/PQyRfgrv6aoNjhasp/p4qs9FjJ4q4cQk+8m4r6k4ZSiEyytKG8f8W9gi8WsQtIObNmKd+tMzNTmA==
 
-dotenv@^8.2.0:
+dotenv@^8.1.0, dotenv@^8.2.0:
   version "8.2.0"
   resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-8.2.0.tgz#97e619259ada750eea3e4ea3e26bceea5424b16a"
   integrity sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==
@@ -5886,6 +5896,16 @@ load-json-file@^2.0.0:
     pify "^2.0.0"
     strip-bom "^3.0.0"
 
+load-json-file@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/load-json-file/-/load-json-file-4.0.0.tgz#2f5f45ab91e33216234fd53adab668eb4ec0993b"
+  integrity sha1-L19Fq5HjMhYjT9U62rZo607AmTs=
+  dependencies:
+    graceful-fs "^4.1.2"
+    parse-json "^4.0.0"
+    pify "^3.0.0"
+    strip-bom "^3.0.0"
+
 loader-runner@^2.4.0:
   version "2.4.0"
   resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-2.4.0.tgz#ed47066bfe534d7e84c4c7b9998c2a75607d9357"
@@ -6181,6 +6201,11 @@ memory-fs@^0.5.0:
     errno "^0.1.3"
     readable-stream "^2.0.1"
 
+memorystream@^0.3.1:
+  version "0.3.1"
+  resolved "https://registry.yarnpkg.com/memorystream/-/memorystream-0.3.1.tgz#86d7090b30ce455d63fbae12dda51a47ddcaf9b2"
+  integrity sha1-htcJCzDORV1j+64S3aUaR93K+bI=
+
 meow@^7.0.1:
   version "7.0.1"
   resolved "https://registry.yarnpkg.com/meow/-/meow-7.0.1.tgz#1ed4a0a50b3844b451369c48362eb0515f04c1dc"
@@ -6361,7 +6386,7 @@ minimist-options@^4.0.2:
     is-plain-obj "^1.1.0"
     kind-of "^6.0.3"
 
-minimist@^1.2.0, minimist@^1.2.5:
+minimist@^1.1.3, minimist@^1.2.0, minimist@^1.2.5:
   version "1.2.5"
   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602"
   integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==
@@ -6643,6 +6668,21 @@ npm-conf@^1.1.3:
     config-chain "^1.1.11"
     pify "^3.0.0"
 
+npm-run-all@^4.1.5:
+  version "4.1.5"
+  resolved "https://registry.yarnpkg.com/npm-run-all/-/npm-run-all-4.1.5.tgz#04476202a15ee0e2e214080861bff12a51d98fba"
+  integrity sha512-Oo82gJDAVcaMdi3nuoKFavkIHBRVqQ1qvMb+9LHk/cF4P6B2m8aP04hGf7oL6wZ9BuGwX1onlLhpuoofSyoQDQ==
+  dependencies:
+    ansi-styles "^3.2.1"
+    chalk "^2.4.1"
+    cross-spawn "^6.0.5"
+    memorystream "^0.3.1"
+    minimatch "^3.0.4"
+    pidtree "^0.3.0"
+    read-pkg "^3.0.0"
+    shell-quote "^1.6.1"
+    string.prototype.padend "^3.0.0"
+
 npm-run-path@^2.0.0:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-2.0.2.tgz#35a9232dfa35d7067b4cb2ddf2357b1871536c5f"
@@ -7132,6 +7172,13 @@ path-type@^2.0.0:
   dependencies:
     pify "^2.0.0"
 
+path-type@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/path-type/-/path-type-3.0.0.tgz#cef31dc8e0a1a3bb0d105c0cd97cf3bf47f4e36f"
+  integrity sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==
+  dependencies:
+    pify "^3.0.0"
+
 path-type@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b"
@@ -7163,6 +7210,11 @@ picomatch@^2.0.4, picomatch@^2.0.5, picomatch@^2.2.1:
   resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.2.2.tgz#21f333e9b6b8eaff02468f5146ea406d345f4dad"
   integrity sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==
 
+pidtree@^0.3.0:
+  version "0.3.1"
+  resolved "https://registry.yarnpkg.com/pidtree/-/pidtree-0.3.1.tgz#ef09ac2cc0533df1f3250ccf2c4d366b0d12114a"
+  integrity sha512-qQbW94hLHEqCg7nhby4yRC7G2+jYHY4Rguc2bjw7Uug4GIJuu1tvf2uHaZv5Q8zdt+WKJ6qK1FOI6amaWUo5FA==
+
 pify@^2.0.0:
   version "2.3.0"
   resolved "https://registry.yarnpkg.com/pify/-/pify-2.3.0.tgz#ed141a6ac043a849ea588498e7dca8b15330e90c"
@@ -8057,6 +8109,15 @@ read-pkg@^2.0.0:
     normalize-package-data "^2.3.2"
     path-type "^2.0.0"
 
+read-pkg@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/read-pkg/-/read-pkg-3.0.0.tgz#9cbc686978fee65d16c00e2b19c237fcf6e38389"
+  integrity sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=
+  dependencies:
+    load-json-file "^4.0.0"
+    normalize-package-data "^2.3.2"
+    path-type "^3.0.0"
+
 read-pkg@^5.2.0:
   version "5.2.0"
   resolved "https://registry.yarnpkg.com/read-pkg/-/read-pkg-5.2.0.tgz#7bf295438ca5a33e56cd30e053b34ee7250c93cc"
@@ -8746,6 +8807,11 @@ shebang-regex@^3.0.0:
   resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172"
   integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==
 
+shell-quote@^1.6.1:
+  version "1.7.2"
+  resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.7.2.tgz#67a7d02c76c9da24f99d20808fcaded0e0e04be2"
+  integrity sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==
+
 side-channel@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.0.2.tgz#df5d1abadb4e4bf4af1cd8852bf132d2f7876947"
@@ -9100,6 +9166,14 @@ string.prototype.matchall@^4.0.2:
     regexp.prototype.flags "^1.3.0"
     side-channel "^1.0.2"
 
+string.prototype.padend@^3.0.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/string.prototype.padend/-/string.prototype.padend-3.1.0.tgz#dc08f57a8010dc5c153550318f67e13adbb72ac3"
+  integrity sha512-3aIv8Ffdp8EZj8iLwREGpQaUZiPyrWrpzMBHvkiSW/bK/EGve9np07Vwy7IJ5waydpGXzQZu/F8Oze2/IWkBaA==
+  dependencies:
+    define-properties "^1.1.3"
+    es-abstract "^1.17.0-next.1"
+
 string.prototype.trimend@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/string.prototype.trimend/-/string.prototype.trimend-1.0.1.tgz#85812a6b847ac002270f5808146064c995fb6913"