The mymonero-app-js from isabella232

MyMonero Desktop

The simplest way to use the next-generation private digital currency Monero, at the sweet spot between security, convenience, and features

Downloads
Requirements & Install Locations
Reporting Bugs & Making Feature Requests
Installation
Building for Production
Running in Development Mode
Contributing
Acknowledgements
License and Copyrights

Downloads

Download the latest version from our website at mymonero.com or from the Releases tab.

Developers and pre-release testers who would like to use and work on the app can run it by obtaining the source and running one of the build commands below.

To get set up with the source code, please see Getting the Source Code below.

Requirements & Install Locations

The desktop app is built on Electron and can be packaged to run on modern versions of:

MacOS (.app)
Windows (installer .exe)
Linux (.appimage)

Where is user data saved?

Desktop: See Electron's app.getPath('userData')

Reporting Bugs & Making Feature Requests

If you would like to report an issue or share a feature request, please create a Github Issue on this project.

If you're reporting a bug, be sure to include all information which we would need to reproduce the issue, such as the operating system and app version on which you saw the bug, and the steps you took, if you can tell.

Please contact us via contact us for general support and enquiries. Please only use the Issues tracker when you believe you've encountered a bug.

Installation

Before installing, download and install Node.js.

Clone the repo and install the dependencies.

git clone https://github.com/mymonero/mymonero-app-js.git
cd mymonero-app-js

npm install

To start the desktop wallet, run the following

npm start

Building for Production

If you're testing a pre-release version of this app and need to verify its behavior in production mode or want to obtain an installable release bundle, see Packaging the App for Production Mode.

Running in Development Mode

Does not require you to package, sign, and install the app, and will cause the Developer window to be shown. Certain features, such as URL opening under MacOS, require production build.

npm run dev

Contributing

Testing

Please submit any bugs as Issues unless they have already been reported.

Suggestions and feedback are very welcome!

Developing

If you have an improvement to the codebase and would like to have your code shipped in the production MyMonero app, please submit a pull request, even if it's still a WIP. We try to credit all contributors in app release notes.

Before contributing, please spend a few moments scanning the technology notes to learn about libraries used, reasons behind some architectural choices, and more.

Merging PRs which involve integrating with any third-party services will require discussion and agreement.
We reserve the right to refuse to merge any PRs, such as those which introduce breaking changes.

The maintainer enjoys collaborating with volunteer contributors to the MyMonero apps over IRC private message and the #mymonero room on freenode.net (Come say hello!), so PR'd submissions do not have to be at all complete or perfect on their first submission. (To submit a draft PR for review, simply mark it as '[DO NOT MERGE]')

For background on this project, see Why We Built the Native Apps.

You may also like to read the unofficial Technology Roadmap to get a peek at what we're thinking about for the future.

There's also an icebox of ideas, features, improvements, known issues, and other todos waiting to be knocked out which are kept in the Issues tracker.

Donating

MyMonero Donation Address (XMR): 48yi8KBxh7fdZzwnX2kFCGALRcN1sNjwBHDfd5i9WLAWKs7G9rVbXNnbJTqZhhZCiudVtaMJKrXxmBeBR9kggBXr8X7PxPT

Proceeds from donations are used to fund development on the MyMonero back-end server (a performant version of which we soon™ plan to open-source for anyone to run their own server at home). Any remaining funds will go towards product (app UI) R&D, and hosting costs.

Acknowledgements

Contributors to each release are credited in release notes.

Core Contributors

🍕 Tekkzbadger (Devin Pearson) Lead maintainer; core developer
💱 j_karlos (Karl Buys) Maintainer; core developer
🦄 fluffyponyza (Riccardo Spagni) Advisor; MyMonero founder; Monero core team member
🏂 endogenic (Paul Shapiro) Former core maintainer; MyMonero core contributor
😎 vtnerd (Lee Clagett) Lead back-end developer
🍄 luigi Monero tech advisor; Main MyMonero JS core crypto contributor
🔥 mds (Matt Smith) MVP designer
🌠 Your name here?

License and Copyrights

See LICENSE.txt for license.

isabella232 / mymonero-app-js Goto Github PK

mymonero-app-js's Introduction

Contents