https://github.com/jamland/samplescope
Desktop app with the main goal to simplify audio samples search over the internet sources.
https://github.com/jamland/samplescope
audio-file audio-samples free-download sample sample-search samples search sfx sound-effects
Last synced: over 1 year ago
JSON representation
Desktop app with the main goal to simplify audio samples search over the internet sources.
- Host: GitHub
- URL: https://github.com/jamland/samplescope
- Owner: jamland
- License: mit
- Created: 2020-07-23T19:05:28.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T23:10:50.000Z (over 3 years ago)
- Last Synced: 2024-10-12T01:30:32.197Z (over 1 year ago)
- Topics: audio-file, audio-samples, free-download, sample, sample-search, samples, search, sfx, sound-effects
- Language: TypeScript
- Homepage: https://jamland.github.io/
- Size: 38.6 MB
- Stars: 25
- Watchers: 2
- Forks: 2
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Samplescope
🟢 Download [Samplescope App for macOS or Windows](https://github.com/jamland/samplescope/releases/)
🟠Please note, using this app you accepting [Application Privacy Policy](https://github.com/jamland/samplescope/blob/main/PRIVACY.md).
## Simply
Samplescope is app to search audio samples over internet
## Detailed
There are 2 main stimulus for this app:
- Give a user a simple (quick and easy) way to search over online samples
- Research the field of available online audio resources
# Development
## TBA: Description followed open source project on github
## Prerequisites
To run app in development env you need create file `.env` based on `.env.example` in projects' root folder. This file need to be updated with correct credentials. Specifically, credentials required to access [Freesound.org](Freesound.org) (called `FREESOUND_API_KEY_DEV`). It can be generated on [Freesound API page](https://freesound.org/apiv2/apply). Other credentials are optional (most likely)
## Commands
Some script commands uses `cross-env` to ensure to set and use environment variables across platforms.
| Command | Description |
| ----------- | ------------------------------------------- |
| start | Start app in DEV mode |
| start:watch | Same and watch for changes |
| make | Compile ready-to-use app |
| package | Compile app (not distributable, use `make`) |
| publish | `make`, notarize and publish to GitHub |
| lint | Lint app |
| lint:app | Lint app w/ `electron-forge` |
| test | Run tests |
Details on [Electron Forge docs for CLI](https://www.electronforge.io/cli)
### Notarize
The config could be found in `forge.config`.
macOS: `APPLE_ID` & `APPLE_ID_PASSWORD` tokens needs to be added to `.env` file. All notarization works done by `src/hooks/notarize` hook on `publish` cmd.
Windows: Code-sign certificate need to be placed within `private/` folder.
The rest of the work for both platforms done automatically on `npm run publish` cmd.
### Publish
This command will attempt to make the forge application and then publish it to the publish targets defined in `forge.config`.
It will post to (or create if not exist) Github's Draft Releases with name of last version.
You need to run publish on each platform you want to support, so `Samplescope-X.X.X.Setup.exe` will be made on posted from Win and `Samplescope-darwin-x64-X.X.X.zip` on MacOS.
## Private Keys
There are some 3rd-party API related credentials, Github token, Apple passwords and other sensative private credentials required to run, package, deploy this app. This credentials should not be published to repository for security reasons, and should be added manually by developer.
Specifically:
- add new `.env` file. There is `.env.example` with example of required keys
- add `./private` folder
- add `./private/GH_TOKEN.txt` file with GitHub token
- add `./private/AppleIdPassword.txt` file with generated Apple Id Password