Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mymonero/mymonero-android-js
https://github.com/mymonero/mymonero-android-js
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mymonero/mymonero-android-js
- Owner: mymonero
- License: bsd-3-clause
- Created: 2020-11-19T08:42:30.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T06:06:28.000Z (2 months ago)
- Last Synced: 2024-10-27T07:19:27.729Z (2 months ago)
- Language: JavaScript
- Size: 22.2 MB
- Stars: 34
- Watchers: 7
- Forks: 12
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## This repo is being archived in favour of our new [mymonero-mobile](https://github.com/mymonero/mymonero-mobile) repo. Any support, downloads or updates will be available there.
# MyMonero Android Wallet
MyMonero Android Wallet
## Downloads
Download the latest version from our website at [Play Store](https://play.google.com/store/apps/details?id=com.mymonero.official_android_application) or from the [Releases tab](https://github.com/mymonero/mymonero-android-js/releases/latest).
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.
### Where is user data saved?
* Android: The data is encrypted and saved to the Android device using an implementation that leverages AndroidKeyStore and SharedPreferences.
* Web: The data is saved to the browser's local storage.
#### Data storage warnings:
* Android API < 18 does not support AndroidKeyStore. Android API < 18 values are stored fallback to being stored as simple base64 encoded strings.
* Since web browsers don't have an equivalent of Android's secure storage, data is base64-encoded before being stored in the browser's Local Storage.
## Reporting Bugs & Making Feature Requests
If you would like to report an issue or share a feature request, please create a Github [Issue](https://github.com/mymonero/monero-android-js/issues) 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 don't use the Issues tracker for general support or inquiries. You can also [contact us](https://mymonero.com/support) directly.
## Installation
Before installing, [download and install Node.js](https://nodejs.org/en/download/). You will also need [Android Studio](https://developer.android.com/studio)
Clone the repo and install the dependencies.
```bash
git clone https://github.com/mymonero/mymonero-android-js.git
cd mymonero-android-js
```
```bash
npm install
```
To open the android app in Android studio, run the following
```bash
npm run build
```
To run the app in a web browser, run the following
```bash
npm start
```
This will build and package the web version of the application in the `browser_build` folder. Once that is done, it will initialise all necessary build files for your Android application. Finally, it will attempt to open the project in Android Studio.
## Suggested development workflow
As the application is essentially a web application which gets transpiled into Java by Capacitor, rather than transpile and build each time, we do most of our development work by running a server that serves the browser_build folder, and accessing it in Chrome. Barring unusual cases, changes made and tested on Chrome will function properly once transpiled.
When developing in this fashion, one can run a server with hot-reload enabled by using the `npm run watch` command
## Debugging the Android application
Should you run into any issues with the transpiled application, you are able to debug the application by making use of Android WebView debugging and the Chrome browser. In order to do so, follow the instructions below:
1. Add the following code snippet to the app/java/com.mymonero.android/MainActivity.java file inside the `onCreate()` function
```
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
WebView.setWebContentsDebuggingEnabled(true);
}
```
2. Open Chrome
3. Navigate to chrome://inspect/#devices
4. Under "Remote Target", you should see a WebView titled "WebView in com.mymonero.android"
5. Click "inspect" to open the WebView in DevTools
## Building for Production
1. Follow the steps under `Download and Build`.
2. Use Android Studio to build the .APK file
## 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](https://help.github.com/articles/about-pull-requests/), even if it's still a WIP. We try to credit all contributors in app release notes.
* 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.
### 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.
## License and Copyrights
See `LICENSE.txt` for license.
All app source code and assets copyright © 2014-2021 by MyMonero. All rights reserved.
## Acknowledgements
Contributors to each release are credited in release notes.
### Core Contributors
* 💱 `jkarlos` ([Karl Buys](https://github.com/karlbuys)) Lead maintainer; core developer
* 🍕 `Tekkzbadger` ([Devin Pearson](https://github.com/devinpearson)) Maintainer; core developer
* 🦄 `fluffyponyza` ([Riccardo Spagni](https://github.com/fluffypony)) Advisor; MyMonero founder; Monero core team member
* 🏂 `endogenic` ([Paul Shapiro](https://github.com/paulshapiro)) Former core maintainer; MyMonero core contributor
* 😎 `vtnerd` ([Lee Clagett](https://github.com/vtnerd)) Lead back-end developer
* 🍄 `luigi` Monero tech advisor; Main MyMonero JS core crypto contributor
* 🔥 `mds` ([Matt Smith](http://mds.is)) MVP designer
* 🌠 Your name here?
## License and Copyrights
See `LICENSE.txt` for license.
All app source code and assets copyright © 2014-2021 by MyMonero. All rights reserved.