voicegardens/README.md

# voicegardens

> An online landscape, built as a tool to explore the many aspects of the human voice.

- [voicegardens](#voicegardens)
  - [Interwebz](#interwebz)
  - [Hackity Hack Hack](#hackity-hack-hack)
  - [Deploying](#deploying)
  - [Layers of the Onion](#layers-of-the-onion)
  - [License](#license)

## Interwebz

- [live site voicegardens.org](https://voicegardens.org)
- [test site doesitsparkjoy.voicegardens.org](http://doesitsparkjoy.voicegardens.org)
- [barbican.org.uk: This is Public Space](https://www.barbican.org.uk/whats-on/2019/event/this-is-public-space)
- [upprojects.com: This is Public Space](https://www.upprojects.com/projects/this-is-public-space/)

## Hackity Hack Hack

```bash
$ sudo apt install -y make git
$ git clone ssh://gitea@vvvvvvaria.org:12345/varia/voicegardens.git
$ cd voicegardens
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
$ make dev-serve
```

## Deploying

You can add the following to your SSH configuration:

```
Host voicegardens.org
  Hostname voicegardens.org
  User voicegardens
  Port 12345
  IdentityFile ~/.ssh/my-ssh-secret-key-file
```

(Where you should replace "my-ssh-secret-key-file" with the real filename.)

Make sure you can SSH into the server.

```bash
$ ssh voicegardens.org
$ sudo -i  # you have root access too
```

Then it's possible to release the site with the following targets.

```bash
$ make doesitsparkjoy  # https://doesitsparkjoy.voicegardens.org
$ make voicegardens  # https://voicegardens.org
```

## Layers of the Onion

- [Flask](http://flask.palletsprojects.com/en/1.1.x/)
- [p5.js](https://p5js.org)

## License

- [AGPL](LICENSE.txt)