Skip to content

Commit

Permalink
Upgrade to Electron 25.3 + Forge 6.2
Browse files Browse the repository at this point in the history
  • Loading branch information
kfranqueiro committed Jul 14, 2023
1 parent 60cf12e commit c282c3e
Show file tree
Hide file tree
Showing 58 changed files with 9,209 additions and 2,627 deletions.
19 changes: 19 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
module.exports = {
env: {
browser: true,
es2021: true,
node: true,
},
extends: ["eslint:recommended", "prettier"],
globals: {
define: "readonly",
electronApi: "readonly",
},
parserOptions: {
ecmaVersion: "latest",
},
plugins: ["prettier"],
rules: {
"prettier/prettier": "error",
},
};
17 changes: 8 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
dist
electron
node_modules
src/dojo
src/dijit
src/dgrid
src/dstore
src/font-awesome
src/resources/**/*.css
node_modules/
out/
src/css/
src/dojo/
src/dijit/
src/dgrid/
src/dstore/
src/font-awesome/
69 changes: 0 additions & 69 deletions .jscsrc

This file was deleted.

72 changes: 0 additions & 72 deletions .jshintrc

This file was deleted.

3 changes: 3 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"printWidth": 100
}
90 changes: 0 additions & 90 deletions Gruntfile.js

This file was deleted.

39 changes: 17 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,39 @@ Electern is an Atom/RSS feed reader built using Electron and dgrid.

# Features

* Organize feeds in nested folders
* Import feeds from OPML (export not supported at this time)
* Pin articles to store them indefinitely
* Download individual articles as complete web pages to read offline (using icon in top right)
* RegExp search within article titles and content
* Configure how many articles to keep, how often to update, and whether to display images
* Defaults can be configured globally (via Preferences), then overridden per-feed
* Supports portable mode via `--portable` command-line flag
* On Mac OS X, you can run `open Electern.app --args --portable`; user data will be saved under the
- Organize feeds in nested folders
- Import feeds from OPML (export not supported at this time)
- Pin articles to store them indefinitely
- Download individual articles as complete web pages to read offline (using icon in top right)
- RegExp search within article titles and content
- Configure how many articles to keep, how often to update, and whether to display images
- Defaults can be configured globally (via Preferences), then overridden per-feed
- Zip distributions support portable mode via `--portable` command-line flag
- On Mac OS X, you can run `open Electern.app --args --portable`; user data will be saved under the
`Contents/MacOS` folder within the app.

# Build Instructions

## Requirements

You will need `bower` and `grunt-cli` installed globally (i.e. `npm i -g bower grunt-cli`).
You will need `bower` installed globally (i.e. `npm i -g bower`).

## Development

1. Clone this repository
1. `npm install` (which will in turn run `bower install`, then `npm install` inside of `src`)
1. `grunt dev`
1. `npm i` (which will in turn run `bower install`)
1. `npm start`
1. If you will be editing SCSS, also run `npm run scss:watch`

## Release

Run `grunt release`
It is possible to build for all platforms from OS X.

# Usage
`brew install fakeroot dpkg wine-stable` to install prequisites

## Running the Application
`npm run make-all` to build for all platforms under `out` subfolder

### Development

Run `bin/run` (or `bin\run.cmd` on Windows).

### Release

Run the application for the respective platform under `dist`.
On other platforms, `npm run make` will build for the current platform only.

## License

Expand Down
35 changes: 0 additions & 35 deletions bin/run

This file was deleted.

1 change: 0 additions & 1 deletion bin/run.cmd

This file was deleted.

Loading

0 comments on commit c282c3e

Please sign in to comment.