31 lines
497 B
Markdown
31 lines
497 B
Markdown
# 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
|
|
git clone https://forge.chapril.org/UncleSamulus/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. |