mirror of
https://github.com/kaythomas0/noisedash.git
synced 2025-11-20 06:58:03 +00:00
86 lines
2.9 KiB
Markdown
86 lines
2.9 KiB
Markdown
# Noisedash
|
|
|
|
Self-hostable web tool for generating ambient noises
|
|
|
|
|
|
|
|
(More screenshots on the [wiki](https://github.com/kaythomas0/noisedash/wiki/Screenshots))
|
|
|
|
# Features
|
|
|
|
* 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. Import and export them for easy sharing, record them for use elsewhere
|
|
* Fine-tune your noises with audio processing tools like filters, LFOs, and effects
|
|
* Upload and edit audio samples (e.g rain, wind, thunder) to combine with your generated noises. Add effects to them and set playback modes
|
|
* Use admin tools to manage multiple users
|
|
* Mobile friendly
|
|
|
|
# Installation
|
|
|
|
## Docker
|
|
|
|
Requires docker and docker-compose
|
|
|
|
* Download the provided [docker-compose.yml file](https://github.com/kaythomas0/noisedash/blob/main/docker-compose.yml)
|
|
* In the same directory as the docker-compose file, created a folder called `config`, and inside it, put the provided [config file](https://github.com/kaythomas0/noisedash/blob/main/config/default.json)
|
|
* Edit the config file to your preference
|
|
* Bring the container up:
|
|
|
|
``` bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
* Proceed to the URL where it's deployed and register your first user
|
|
|
|
(Raspberry Pi compatible images are available, see armv7 images on [Docker Hub](https://hub.docker.com/repository/docker/noisedash/noisedash))
|
|
|
|
## From Source
|
|
|
|
Requires node 14 and npm
|
|
|
|
* Clone the repo:
|
|
|
|
``` bash
|
|
git clone https://github.com/kaythomas0/noisedash.git
|
|
cd noisedash
|
|
```
|
|
|
|
* Edit `config/default.json` to your preference
|
|
* Install required packages and build the app:
|
|
|
|
``` bash
|
|
npm install
|
|
NODE_ENV=production npm run build
|
|
```
|
|
|
|
* The build files will be put into a directory called `dist`
|
|
* Run the server and serve static files:
|
|
|
|
``` bash
|
|
npm run server-prod
|
|
```
|
|
|
|
* Proceed to the URL where it's deployed and register your first user
|
|
|
|
# Contributing
|
|
|
|
See [CONTRIBUTING.md](https://github.com/kaythomas0/noisedash/blob/main/CONTRIBUTING.md)
|
|
|
|
# License
|
|
|
|
Noisedash, a self-hostable web tool for generating ambient noises
|
|
Copyright (C) 2021 Kay Thomas <kaythomas@pm.me>
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as published
|
|
by the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|