external-repos/noisedash
1
0
Fork 1
mirror of https://github.com/kaythomas0/noisedash.git synced 2025-11-11 19:06:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Kevin Thomas
2021-11-13 15:33:07 -08:00
committed by GitHub
parent fbc43be2e8
commit adb20209c5
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,12 +1,14 @@
# Noisedash # Noisedash
Self-hostable web tool for generating ambient noises. Self-hostable web tool for generating ambient noises
![Noisedash](./.github/noisedash-screenshot-1.jpg) ![Noisedash](./.github/noisedash-screenshot-1.jpg)
(More screenshots on the [wiki](https://github.com/KevinThomas0/noisedash/wiki/Screenshots))
# Features # Features
* Generate and customize ambient noises and user-uploadable samples * Generate and customize ambient noises and user-uploadable samples (leveraging [Tone.js](https://github.com/Tonejs/Tone.js/))
* Save "noise profiles" so you can easily switch between your created soundscapes * Save "noise profiles" so you can easily switch between your created soundscapes
* Fine-tune your noises with audio processing tools like filters, LFOs, and effects * Fine-tune your noises with audio processing tools like filters, LFOs, and effects
* Upload audio samples (e.g rain, wind, thunder) to combine with your generated noises * Upload audio samples (e.g rain, wind, thunder) to combine with your generated noises
@@ -28,6 +30,8 @@ Requires docker and docker-compose
docker-compose up -d docker-compose up -d
``` ```
* Proceed to the URL where it's deployed and register your first user
## From Source ## From Source
Requires node 14 and npm Requires node 14 and npm
@@ -54,6 +58,8 @@ NODE_ENV=production npm run build
npm run server-prod npm run server-prod
``` ```
* Proceed to the URL where it's deployed and register your first user
# Contributing # Contributing
See [CONTRIBUTING.md](https://github.com/KevinThomas0/noisedash/blob/main/CONTRIBUTING.md) See [CONTRIBUTING.md](https://github.com/KevinThomas0/noisedash/blob/main/CONTRIBUTING.md)