electron/apps

A collection of apps built on Electron

📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages on our Crowdin project.

The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Visual Studio Code and many other apps.

Follow @electronjs on Twitter for important announcements.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Installation

To install prebuilt Electron binaries, use npm. The preferred method is to install Electron as a development dependency in your app:

npm install electron --save-dev

For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.

Platform support

Each Electron release provides binaries for macOS, Windows, and Linux.

• macOS (Big Sur and up): Electron provides 64-bit Intel and Apple Silicon / ARM binaries for macOS.
• Windows (Windows 10 and up): Electron provides ia32 (x86), x64 (amd64), and arm64 binaries for Windows. Windows on ARM support was added in Electron 5.0.8. Support for Windows 7, 8 and 8.1 was removed in Electron 23, in line with Chromium's Windows deprecation policy.
• Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on:
  • Ubuntu 18.04 and newer
  • Fedora 32 and newer
  • Debian 10 and newer

Quick start & Electron Fiddle

Use Electron Fiddle to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and to try out different versions of Electron. It's designed to make the start of your journey with Electron easier.

Alternatively, clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:

git clone https://github.com/electron/electron-quick-start
cd electron-quick-start
npm install
npm start

Resources for learning Electron

• electronjs.org/docs - All of Electron's documentation
• electron/fiddle - A tool to build, run, and package small Electron experiments
• electron/electron-quick-start - A very basic starter Electron app
• electronjs.org/community#boilerplates - Sample starter apps created by the community

Programmatic usage

Most people use Electron from the command line, but if you require electron inside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:

const electron = require('electron')
const proc = require('node:child_process')

// will print something similar to /Users/maf/.../Electron
console.log(electron)

// spawn Electron
const child = proc.spawn(electron)

Mirrors

• China

See the Advanced Installation Instructions to learn how to use a custom mirror.

Documentation translations

We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.

Contributing

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

Community

Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found on the Community page.

License

MIT

When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.

apps's Issues

Categories

Just collecting some prior art here, in case we want to introduce a set list of categories.

• https://developer.apple.com/app-store/categories/
• https://support.google.com/googleplay/android-developer/answer/113475?hl=en

Use semantic-release

Instead of running a Heroku app to periodically publish to npm, we could use semantic-release to make it happen automatically whenever a PR is merged.

To do so, we'd just need to make sure that we always merge with "squash" and write semantic commit messages.

Upgrade to newer Heroku Stack

Seeing this warning on deploys to Heroku:

Warning: You are running on a deprecated stack.
Please upgrade to the latest stack by following the instructions on:
https://devcenter.heroku.com/articles/upgrading-to-the-latest-stack

Steps: https://devcenter.heroku.com/articles/upgrading-to-the-latest-stack#upgrading-an-app

New app added but ENOENT

Hi, just tried this cool wizard process.

I get this error after i fill the license prompt and hit enter:

? What is the name of the app? ndm
? Short description npm desktop manager
? Website (can be repository URL if app has no website) https://720kb.github.io/
ndm
? Repository (optional) https://github.com/720kb/ndm
? Keywords (optional, comma-delimited) npm,desktop,manager,tool,gui,app
? License (optional) GPL-3.0
(node:2274) UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): Error: ENOENT: no such file or directory, open '/Projects/electron-apps/apps/ndm/ndm.yml'

Nothing serious, just wanted to let you know about it.

app sorting

I was following the apps as an when they were added, I see that it is now sorted by name. it is difficult to follow new apps among the sea of apps listed here.

Can this be sorted by the date it is added again? or can there be option to sort it by the date or name with month based grouping?

Broken link to Tusk app website

Clicking the Tusk app from electron apps homepage leads to a 404

Broken link: https://champloohq.github.io/tusk/

Verify homepage and repository URLs for new apps

When a new app is added, we should check that the URLs are legit.

The test suite could somehow isolate that newly added app (by looking at the latest git commit) and test that its homepage and/or repository URLs are returning 200 status codes.

This test should NOT be run for every app on every test run. That would be slow and probably cause intermittent test failures.

export categories with the npm module

...so the website doesn't have to deal with it.

Example:

[
   {
      "count": 4,
      "name": "Books",
      "slug": "books"
    },
    {
      "count": 7,
      "name": "Business",
      "slug": "business"
    },
    {
      "count": 72,
      "name": "Developer Tools",
      "slug": "developer-tools"
    }
]

We can use the already-depended-on slugg to generate the slugs.

To avoid making this a breaking change, we can just keep the default behavior for require('electron-apps') and access the categories using require('electron-apps/categories')

cc @jkleinsc

Use electron-probot to echo CI failures back to users as a comment

Folks don't usually notice that CI has failed, so I end up clicking into Travis, copying the error, and pasting it back as a comment on the issue so the user can fix it.

https://github.com/electron/electron-probot doesn't do anything yet, but this would be a good use for it.

Colol app not available anymore

Colol app doesn't seem to be available anymore, I get an "Account suspended" page instead of the website.

Can I develop a hybrid app (electronically) with electron?

I am looking for a cross-platform framework.

Can I develop a hybrid app (electronically) with electron?

How is the desktop app different from a hybrid app (web app)?

Stacer does not use electron anymore

https://github.com/oguzhaninan/Stacer/releases

Just saw this when updating stacer, so it should probably be removed from the list ;)

janus-workspace.yml has an invalid repo link

https://github.com/KIvanow/janusWorkspaceNative leads to nowhere.

https://github.com/electron/electron-apps/blob/master/apps/janus-workspace/janus-workspace.yml

Fix relative links in app READMEs

See electron/electronjs.org-old#986

Document deployment schedule

Hi! I'm unable to find any information regarding how often the electron apps list on the website is updated. Perhaps it would be good to mention this in the contribution documentation and/or the readme?

For instance, I submitted my application "Buttercup" 10 days ago and it hasn't appeared on the website yet, so I was just wondering what the average turn-around time is for updates to be pushed to the website.

Thanks!

Making this process better

I feel like we can have a website which has a dedicated way to add apps and details without making a pull request. This would be quick and fast and we can ad much more features like ratings download counter etc. If anyone is interested in this idea I would like to create that site for electron putting my entire heart and sole ❤️ . Waiting for your reply.

Mongo Compass: On remove a row for validate still shows Error input is not valid

Hey! Awesome MognoDB Team! i thinkg a foun d a littel bug.

If you use the awesome Validation tab on the collection and delete a empty row while the current Validation is not valida because the empty rule, you do not have any way to force the web check.

I didn't check how to fix that, if you team are busy I could found the problem, i know it is a web app, but i'm not sure if you agree a pull request.
If i could participate let me know.

I'm not sure if this is the best place to put eh problem, but i didn't find a better place

Thanks!

Deprecated Apps: Ramme and Nylas Featured apps are both deprecated

Hi! I tried to use two of the featured apps, namely Nylas Mail and Ramme, and they are both deprecated as projects and out of development. Just wanted to let you know! Thanks for the awesome website and your hard work! 🎉

Vagrant Manager

The 1.1 edition of Vagrant Manager is now outdated & has refused PR updated. I've forked it & now version is at 1.2.3, with a version 2 release coming soon.

What's the process of updating the Electron JS app reference when apps move maintainers?

Validate all images are actually images during the tests

We could do a HEAD request to all image URL's to ensure the mimeType returned is actually an image.

This would prevent things like #430 where the URL added didn't actually point to an image 👍

Existing tests: https://github.com/electron/electron-apps/blob/master/test/human-data.js#L100

Account for "apps" that are installed with npm

Let's figure out a way to support apps that are npm-installed, like https://github.com/springload/screenshotron

Maybe a new npmPackageName property or something...

Use electron-probot to echo a PR's screenshots, logos, URLs, etc as a comment

Similar to #262, but this would just make reviewing PRs a bit easier.

Collect names for homebrew casks and chocolatey packages

We should support optional homebrewCaskName and chocolateyPackageName (or similarly named) properties in app metadata. This would allow us to display brew cask install foo and choco install foo one-liners (for Mac and Windows, respectively) on the Electron website.

Related: desktop/desktop#2508

Slack a Gist when the release script fails

Every once in a blue moon, this app's release script on Heroku fails. Usually it's because GitHub or npm is down. The Electron website has a Heroku release script that saves failures output to a gist and send the url to Slack. Let's borrow that technique and use it here: electron/electronjs.org-old#729

Make colors.json data structure deterministic

The bot is publishing new versions too frequently because of subtle changes in the order of content in the colors.json file.

Example: 9714913

Solution: Sort the slug keys in colors.json alphabetically before writing the file.

jqi is missing

Hi guys,

I've submitted my app, jqi, few days ago. It was merged but I still cannot see it in apps list.
Can you advise please?

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

requested to add an application but Travis CI build is failing

Hello,

I have done this pull request
#785

But as you can see I receive a message that buit is faling because something related to "color", I have no idea what is speaking about, I am a novel developer and I am somewhat confused even managing git, but I have no put any "color" in my YML file. What can I do? Someone can solve this?

Notify slack on release failures

As @whyboris recently pointed out, the module has not been published in several days. We should set up a heroku -> papertrail -> slack alert to get notified when the release process is broken.

Update release script to account for mismatched git tags

Sometimes the automated release script fails with an error like tag 'v1.4680.0' already exists:

Sep 12 09:19:18 github-electron-apps app/scheduler.1299:  + git config user.email [email protected] 
Sep 12 09:19:18 github-electron-apps app/scheduler.1299:  + git config user.name 'Electron Bot' 
Sep 12 09:19:18 github-electron-apps app/scheduler.1299:  + git add . 
Sep 12 09:19:18 github-electron-apps app/scheduler.1299:  + git commit -am 'update apps' --author 'Electron Bot <[email protected]>' 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  [master e08a3ce] update apps 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  v1.4680.0 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! code 128 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! Command failed: git tag v1.4680.0 -am bump minor to 1.4680.0 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! fatal: tag 'v1.4680.0' already exists 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR!  
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! A complete log of this run can be found in: 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR!     /app/.npm/_logs/2018-09-12T16_19_18_980Z-debug.log 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! code ELIFECYCLE 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! errno 1 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! [email protected] release: `script/release.sh` 
Sep 12 09:19:19 github-electron-apps app/scheduler.1299:  npm ERR! Exit status 1

This is caused when the previous run of the release script successfully created a tag but didn't manage to git push the code with the included package.json bump.

To work around this occasional hiccup, we should catch this error and manually bump the package.json version first so the script can continue.

Publishes are broken

The following is failing on the publish step:

 9503 passing (2s)
 1 failing
 1) machine-generated app data (exported by the module) sets a `colors.faintColorOnWhite` semi-transparent rgba value on every app:
    AssertionError: expected 'rgb(82, 168, 255, .25)' to match /rgba\(\d+, \d+, \d+, 0\.1\)/
     at apps.forEach.app (test/machine-data.js:57:40)
     at Array.forEach (<anonymous>)
     at Context.it (test/machine-data.js:56:10)

avoid costly and unnecessary image processing while building

The release process is timing out on Heroku because the color palette extraction step is taking too long. Let's solve this by only recalculating things like image sizes and colors when the image file has actually changed. We can probably achieve this by storing some kind of hash of the image and only do expensive operations if the hash is new or has changed.

checklist for reviewers

Currently, as a reviewer approving apps submission, I check the PR against the requirements listed in our contribution guide. The guide is super comprehensive, but a lot of the rules listed there are already automatically checked by tests as part of CI.

It will be very helpful to have a checklist of items that need human eyes & judgment. Better yet, have a bot that comments on each add app PR with said checklist so reviewers can check them off as they go!

How to submit an app

Pardon me if i'm just really stupid right now. But i cannot for the love of me figure out how this submission system works. The website says to create a new pull request in this repository. And the instructions says that i need to add a icon and a yml file with all the information about the app. That much is obvious.

But when i try to create a new pull request. I get to the "Compare changes" part and the "Create pull request" button is grayed out unless i select a specific branch or fork. But if i do that. The bot will close it instantly after creation.

I'm still relatively new to using Github. So i'm sure the answer is obvious. But still. I could really use some more help on this issue.

The app page is not up to date.

Currently: https://github.com/kimyearho/SharePod

https://github.com/electron/apps/blob/master/apps/sharepod/sharepod.yml

App page: https://electronjs.org/apps/sharepod

The page is not updated.
Why is that?

Add application pull request fails with "1) colors should create entries with the expected properties: ..."

I submitted a pull request, adding my Mac / Windows Electron app Movie Scores: #797

I receive an email that the build has failed with the following messsage:

npm test
> [email protected] test /home/travis/build/electron/apps
> mocha --reporter min test/human-data.js test/colors-spec.js && standard --fix

calculating good colors for white
calculating good colors for white
calculating good colors for black
calculating good colors for white
calculating good colors for black
calculating good colors for white
calculating good colors for black
calculating good colors for white
calculating good colors for black
calculating good colors for black
calculating good colors for white

  12947 passing (6s)
  1 failing

  1) colors should create entries with the expected properties:
     Error: Timeout of 2000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves.

Any ideas?

Thanks.

website: 'http://code.rpgify.com' leads anywhere but to rpgify.com

https://github.com/electron/electron-apps/blob/master/apps/code-rpgify/code-rpgify.yml contains a Link that leads to a chain of redirects.

tests sometime fail in `expected {} to have key 'white'`

Example:

> mocha --reporter min test/human-data.js test/colors-spec.js && standard --fix

calculating good colors for white
calculating good colors for black
calculating good colors for white
calculating good colors for black
calculating good colors for white
calculating good colors for black
calculating good colors for white

  12967 passing (4s)
  1 failing

  1) colors should create entries with the expected properties:

      AssertionError: expected {} to have key 'white'
      + expected - actual

      -[]
      +[
      +  "white"
      +]
      
      at Context.it (test/colors-spec.js:57:13)
      at <anonymous>

»Thunder« app outdated?

The app Thunder seems to be outdated as it’s unreachable and I couldn’t find further info anywhere.

According to whois.net, the domain trollswebapp.com expired 2 days ago. I couldn’t find the icon or description anywhere else either.

cc @davidsolorzano20 who added it with #214

app license field

separe opensource apps from comercial

Hello!

My name is Radu Dan, I am a pro graphic designer and a contribuitor in Utopian community. I saw your logo and I want to know if you want a new proposal for your logo. If you will like it and if you will use it, you will have a new logo, and I will be able to make my Utopian account stronger.Regards!

Front-End Box link seems to be broken...

The URL where it redirects to: http://frontendbox.io/
Not sure this is considered as a problem for this repo, but if the issue persists, it might be better to remove the reference.
(Hope it's not a problem with my config. Otherwise sorry for the noise.
(Not sure I should have opened an issue for that...)

Please add pagination on Electron Apps Page.

Electron app page seems not up to date

I created my pull request nearly 2 days ago . I can find my app on here but i cant find it on website . Have I done something wrong ?

App name : FridayAI

Alternative for a rapid development

Hello,

Why not use Jekyll serving in GitHub Pages using Staticman for recive new project and create a markdown file.

Could I create a fork and do a pull request?

Idea: create a twitter card image for each app

When we start making standalone app pages, then links in places like Slack could have a nice preview, assuming we get the meta tags right and everything:

Collaborate with AppImageHub?

Hi, I am working on https://github.com/AppImage/AppImageHub and I have noticed that our projects are doing a very similar thing - perhaps we could collaborate?

Zeplin is not using electron

</3

https://twitter.com/zeplin_io/status/842437674606637060

i thought i'd look into this when i saw the update was only 12MB - i was wondering how they pulled it off with electron! as it turns out, the app is entirely native

Prevent apps from having duplicated website and repo

If repository is a GitHub repo, and website is also that same repo, website should be removed.

This will prevent this kind of redundancy:

cc @donokuda

No Latest release is being showed up on sharp-tune app

I have made some updates and had a new release but it does not seem to be updated on https://electronjs.org/apps/sharp-tune