Birdopedia

A static, photography-first bird encyclopedia built from your own images.

Getting Started

1. Fill in your author settings in config.json.

2. Add your eBird API key to .env:

   EBIRD_API_TOKEN=your_key_here

3. Install dependencies:

   npm install

4. Fetch data + build the pages:

   node scripts/fetch-data.js
   node scripts/build.js

5. Run the local server:

   node server.js

Open http://localhost:3000 in your browser.

Generated Output

public/ is fully generated. You can delete it at any time and recreate it by running the build scripts. Source assets live in templates/.

Adding a New Species

1. Create a folder under public/img/ named exactly as the common name:

   public/img/Red-breasted Nuthatch/
   

2. Add your photos into that folder.

3. Regenerate data and pages:

   node scripts/fetch-ebird.js
   node scripts/build.js

If the folder name does not match an eBird common name, add a mapping in data/ebird.overrides.json (copy from data/ebird.overrides.example.json).

Adding New Photos to an Existing Species

1. Drop the new images into the existing species folder under public/img/.

2. Rebuild the pages:

   node scripts/build.js

If you also want to refresh taxonomy + Wikidata details, run node scripts/fetch-data.js before rebuilding.