diff --git a/.travis.yml b/.travis.yml index f2bc225a..63064f80 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,7 +31,6 @@ addons: install: - git config --global core.autocrlf input - git reset --hard HEAD - - npm run sencha:clean - npm install - npm uninstall electron-prebuilt - npm i electron@$ELECTRON @@ -52,8 +51,7 @@ script: - node --version - npm --version - sencha audit - - npm run sencha:compile - - npm run build:$TRAVIS_OS_NAME + - npm run setup:$TRAVIS_OS_NAME deploy: provider: releases diff --git a/README.md b/README.md index d23ec590..e5f167f3 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,10 @@ - [Privacy](#privacy) - [Donations](#donations) - [Translations](#translations) -- [Install on Linux - Steps](#install-on-linux---steps) +- [Compiling](#compiling) - [To Do](#to-do) - [Contributing](#contributing) +- [Quickstart](#quickstart) - [Disclosure](#disclosure) - [Licence](#licence) @@ -178,11 +179,11 @@ ## Privacy -No personal information will be saved +No personal information will be saved or tracked. Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews. So every time you open Rambox, your sessions will keep alive until you remove the service. -Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). You are always welcome to check the code! ;) +Sync feature use [Auth0](https://auth0.com/) for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). You are always welcome to check the code! ;) ## Donations @@ -190,7 +191,21 @@ Sync feature use Auth0 for Single Sign On & Token Based Authentication and to st |--------------------|:------------------------------------------------------------------------------------------:| I'll think about it later. -## [Install on Linux - Steps](https://github.com/TheGoddessInari/rambox/wiki/Install-on-Linux) +## Compiling + +To build your own copy, you need a recent version of [Sencha CMD](https://www.sencha.com/products/extjs/cmd-download/), and to install it with the Compass extension. +This **needs** to be added to your PATH. + +```shell +git clone https://github.com/TheGoddessInari/rambox.git +cd rambox +cp env-sample.js env.js +# update env.js with your auth0 details. +npm install +npm run setup:win64 +``` +You can substitute win64 for linux32, linux64, win32, or osx as desired. This will create installers appropriate to your platform in dist. +Win32 builds are **deprecated** by electron-builder and is likely to be removed at some point in the future. ## Contributing diff --git a/appveyor.yml b/appveyor.yml index f7b24574..b97e7131 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -28,11 +28,9 @@ install: git reset --hard HEAD npm i npm@latest -g - - npm run sencha:clean - + npm install - + npm prune cache: - '%APPDATA%\npm-cache' @@ -44,9 +42,7 @@ build_script: npm --version - npm run sencha:compile - - npm run build:win64 + npm run setup:win64 test: off artifacts: - path: dist\squirrel-windows\*.exe diff --git a/package.json b/package.json index f03d5ab9..0de4569b 100644 --- a/package.json +++ b/package.json @@ -26,8 +26,13 @@ "build:win": "electron-builder --win --ia32 --x64", "build:win32": "electron-builder --win --ia32", "build:win64": "electron-builder --win --x64", - "setup:osx": "npm run sencha:clean && npm run sencha:compile && npm run clean:osx && npm run pack:osx && npm run build:osx", - "setup:win": "npm run sencha:clean && npm run sencha:compile && npm run clean:win && npm run pack:win && npm run build:win", + "setup:osx": "npm run sencha:clean && npm run sencha:compile && npm run build:osx", + "setup:win": "npm run sencha:clean && npm run sencha:compile && npm run build:win", + "setup:win32": "npm run sencha:clean && npm run sencha:compile && npm run build:win32", + "setup:win64": "npm run sencha:clean && npm run sencha:compile && npm run build:win64", + "setup:linux": "npm run sencha:clean && npm run sencha:compile && npm run build:linux", + "setup:linux32": "npm run sencha:clean && npm run sencha:compile && npm run build:linux32", + "setup:linux64": "npm run sencha:clean && npm run sencha:compile && npm run build:linux64", "all:win": "npm run sencha:clean && npm run sencha:compile && npm run clean:win && npm run pack:win && npm run zip:win32 && npm run zip:win64 && npm run build:win", "all:linux": "npm run sencha:clean && npm run sencha:compile && npm run build:linux" },