chs_pwd_finance_app
v1.3.2
Published
Charleston County Public Works Department In-House Software
Downloads
159
Readme
RELEASES HOSTED HERE:
https://github.com/nareshramabhotla/PWD_APPS_PUBLIC/releases
PYTHON SCRIPTS LOCATED HERE:
https://github.com/Quintuplin/CHS_PWD_19
TO RUN/TEST:
- terminal
npm install
- terminal
npm start
TO DEPLOY TO AUTOUPDATE:
- have a change worth applying to ALL APP USERS
- bugfixes are always worthwhile
- new features, when ready, are also worthwhile
- update package.json: line 4: 'version': change the number to a higher number
- e.g. 1.0.4 -> 1.0.5
- version number increments like so:
- 1.x.x : MAJOR CHANGE, BREAKS ALL PREVIOUS VERSIONS OF THE APP
- x.1.x : NEW FEATURE, DOESN'T BREAK ANYTHING
- x.x.1 : bugfix or similar small change
- when updating a big number, all smaller numbers are reset to 0; e.g. 1.0.0 -> 1.0.1 -> 1.0.2 -> 1.1.0 -> 1.1.1 -> 2.0.0
- terminal
npm publish
- go to https://github.com/nareshramabhotla/PWD_APPS_PUBLIC/releases
- your update should be listed as a
draft
- click
edit
on your update and clicksubmit
at the bottom - your update will now be marked as
latest
and ALL APP USERS WILL AUTOUPDATE TO IT.
Electron App
Built from a base of the electron-quick-start, but with all files which are not understood/utilized removed. A clean project, so to speak.
Zenhub link
https://app.zenhub.com/workspaces/chs-pwd-zenhub-tracker-5df25520af2774b2b298618c/reports/burndown?milestoneId=4925507
electron-quick-start
Clone and run for a quick way to see Electron in action.
This is a minimal Electron application based on the Quick Start Guide within the Electron documentation.
Use this app along with the Electron API Demos app for API code examples to help you get started.
A basic Electron application needs just these files:
package.json
- Points to the app's main file and lists its details and dependencies.main.js
- Starts the app and creates a browser window to render HTML. This is the app's main process.index.html
- A web page to render. This is the app's renderer process.
You can learn more about each of these components within the Quick Start Guide.
To Use
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
git clone https://github.com/electron/electron-quick-start
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install
# Run the app
npm start
Note: If you're using Linux Bash for Windows, see this guide or use node
from the command prompt.
Resources for Learning Electron
- electronjs.org/docs - all of Electron's documentation
- electronjs.org/community#boilerplates - sample starter apps created by the community
- electron/electron-quick-start - a very basic starter Electron app
- electron/simple-samples - small applications with ideas for taking them further
- electron/electron-api-demos - an Electron app that teaches you how to use Electron
- hokein/electron-sample-apps - small demo apps for the various Electron APIs
License
Build and Self-Update from iffy/Matt Haggard on github
What the guide is missing:
npm login
before publish if you want your own name as authornpm publish
instead ofnpm run publish
in current version of node
If configured properly, a new release can be done by simply running npm run publish
If that does not work, follow the readme below (cloned from https://github.com/iffy/electron-updater-example)
This repo contains the bare minimum code to have an auto-updating Electron app using electron-updater
with releases stored on GitHub.
If you can't use GitHub, you can use other providers:
- Complete electron-updater HTTP example
- Complete electron-updater from gitlab.com private repo example
NOTE: If you want to run through this whole process, you will need to fork this repo on GitHub and replace all instances of iffy
with your GitHub username before doing the following steps.
For macOS, you will need a code-signing certificate.
Install Xcode (from the App Store), then follow these instructions to make sure you have a "Mac Developer" certificate. If you'd like to export the certificate (for automated building, for instance) you can. You would then follow these instructions.
Adjust
package.json
if needed.By default,
electron-updater
will try to detect the GitHub settings (such as the repo name and owner) from reading the.git/config
or from reading other attributes withinpackage.json
. If the auto-detected settings are not what you want, configure thepublish
property as follows:{ ... "build": { "publish": [{ "provider": "github", "owner": "iffy", "repo": "electron-updater-example" }], ... } }
Install necessary dependencies with:
yarn
or
npm install
Generate a GitHub access token by going to https://github.com/settings/tokens/new. The access token should have the
repo
scope/permission. Once you have the token, assign it to an environment variableOn macOS/linux:
export GH_TOKEN="<YOUR_TOKEN_HERE>"
On Windows, run in powershell:
[Environment]::SetEnvironmentVariable("GH_TOKEN","<YOUR_TOKEN_HERE>","User")
Make sure to restart IDE/Terminal to inherit latest env variable.
Publish for your platform with:
build -p always
or
npm run publish
If you want to publish for more platforms, edit the
publish
script inpackage.json
. For instance, to build for Windows and macOS:... "scripts": { "publish": "build --mac --win -p always" }, ...
Release the release on GitHub by going to https://github.com/YOUR_GIT_HUB_USERNAME/electron-updater-example/releases, editing the release and clicking "Publish release."
Download and install the app from https://github.com/YOUR_GIT_HUB_USERNAME/electron-updater-example/releases.
Update the version in
package.json
, commit and push to GitHub.Do steps 5 and 6 again.
Open the installed version of the app and see that it updates itself.