mirror of
https://github.com/kaythomas0/noisedash.git
synced 2025-11-11 19:06:20 +00:00
Update README.md
This commit is contained in:
10
README.md
10
README.md
@@ -1,12 +1,14 @@
|
||||
# Noisedash
|
||||
|
||||
Self-hostable web tool for generating ambient noises.
|
||||
Self-hostable web tool for generating ambient noises
|
||||
|
||||

|
||||
|
||||
(More screenshots on the [wiki](https://github.com/KevinThomas0/noisedash/wiki/Screenshots))
|
||||
|
||||
# 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
|
||||
* 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
|
||||
@@ -28,6 +30,8 @@ Requires docker and docker-compose
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
* Proceed to the URL where it's deployed and register your first user
|
||||
|
||||
## From Source
|
||||
|
||||
Requires node 14 and npm
|
||||
@@ -54,6 +58,8 @@ NODE_ENV=production npm run build
|
||||
npm run server-prod
|
||||
```
|
||||
|
||||
* Proceed to the URL where it's deployed and register your first user
|
||||
|
||||
# Contributing
|
||||
|
||||
See [CONTRIBUTING.md](https://github.com/KevinThomas0/noisedash/blob/main/CONTRIBUTING.md)
|
||||
|
||||
Reference in New Issue
Block a user