SoundRecorder

A simple sound recording Android app implementing Material Design

---

Project maintained by naXa777 Hosted on GitHub Pages — Theme by mattgraham

Easy Sound Recorder 2

Contributing

Contributors are more than welcome. How can you contribute?

Report bugs

We want our app to be as stable as possible thus your bug reports are immensely valuable. File GitHub Issues for anything that is unexpectedly broken.

• App version
• Device model
• Android version
• Steps to reproduce the bug
• Expected behavior
• Actual behavior (a screenshot and/or log file may be helpful)

Contribute Code

We have labeled tasks you can help with as help wanted and good first issue. Just pick up an issue that you’re interested in and start coding. If you have a great idea you really want to implement, start by logging an issue for us. We’ll let you know if it fits with our product direction and then you can start development. When you’re ready open a Pull Request with a description of your changes.

A quick note: See Chris Beams’ guide to writing good commit messages - How to Write a Git Commit Message.

Translate

You don’t have to be a programmer if you want to translate this application in your own language or improve existing translations. You can translate SoundRecorder using POEditor - a collaborative translation platform.

Automate Testing

Testing is imperative to the health of the project. There’s a configured CI pipeline (Travis CI) intended for running unit tests and instrumented tests on every commit to the repository, but unfortunately, there’re very few tests at the moment.

Please follow standard guidelines if you want to contribute a test:

1. Android Developers - Test apps on Android
2. Android Studio - Test your app
3. GitHub - Android testing samples

Screenshots

Building

If you want to run the app locally, do the following:

1. Download or clone the repository
2. If you don’t have a Fabric account -> Sign up at fabric.io
3. Declare environment variables of which the name starts with ORG_GRADLE_PROJECT_ followed by the property name (include your own Fabric apiKey and apiSecret). export ORG_GRADLE_PROJECT_soundrecorderCrashlyticsApiSecret=0cf7c9df6d057e7bb62b1427ab364e8115a75fcf7430873b6274bb094d1a8adb
export ORG_GRADLE_PROJECT_soundrecorderCrashlyticsApiKey=cc238b2a4866c96030 Then fabric.properties file will be created automatically by Gradle on the first build. Do not commit this file to a version control, keep it secret.
4. Import the project in your IDE (we use Gradle + Android Studio to build)
5. You should now be able to build and run the app.

See Crashlytics Kit Setup Demo if you need more help.

Dev environment

• Android Studio 3.3 is used for development
• Gradle 4.10 is used to build the project
• Android SDK 9.0 (Pie), API level 28

Permissions needed for the app are:

• record audio
• write to external storage (to store recordings)
• read from external storage (to playback recordings)
• internet access (for stats collection)

Since February 2017 Google enforces a strict privacy policy requirement for apps using sensitive permissions (the RECORD_AUDIO permission). See Privacy Policy of Easy Sound Recorder 2.

Credits / Libraries used:

• Java MP4 Parser
• Circular Progress Bar
• Material Components for Android