soundbirder/README.md

31 lines
492 B
Markdown
Raw Permalink Normal View History

2022-08-17 13:21:00 +02:00
# soundbirder
A web application to play with bird sound identification with data from eBird and Xeno-Canto.
## Requirements
- NodeJS, NPM
- MariaDB (MySQL)
- eBird API key
## Installation
```bash
2023-07-29 18:21:40 +02:00
git clone https://forge.chapril.org/sortion/soundbirder
cd soundbirder
npm install
```
Setup the EBIRD_API_KEY in `.env`:
```text
EBIRD_API_KEY="secret"
```
```bash
npm start
```
Then go to [http://localhost:3000](http://localhost:3000), and have fun !
TODO: add database configuration.