fieldnotes

iFieldnotes

Overview

Write, edit and view fieldnotes.

This app is best used in conjunction with iNaturalist.

Visit the web site at: iFieldnotes

Running the project on your local machine

# Clone the repository
git clone https://github.com/danhartley/fieldnotes.git

# Change into the project directory
cd fieldnotes

# Install node packages
npm run install

# Run the project on your machine
npm run start

# Run unit tests
npm run test

Running integration tests

Open site in browser e.g. npm run start

# node {path} e.g. 
node public/tests/read-fieldnotes/read-fieldnotes-page.js
node public/tests/read-fieldnotes/read-fieldnotes-tracker.js
node public/tests/read-fieldnotes/read-fieldnotes-lighthouse.js

To run tests or view in browser with compressed code:

npm run build
npm run serve
# E2E test
node public/tests/read-fieldnotes/read-fieldnotes-page.js
# In the browser, navigate to locally served site

To compare figures filter network requests in Chrome DevTools
e.g. /axe|sentry|a11y-engine-core.min.js|firestore|logr-ingest.com/
Then toggle the invert flag

Routing

Routing on the production site is handled by Netlify. See the _redirects file for configuration details

No routing is set up in the development environment. Use full paths e.g.
http://localhost:1234/read-fieldnotes.html
http://localhost:1234/write-fieldnotes-create.html
http://localhost:1234/write-fieldnotes-edit.html
http://localhost:1234/read-inaturalist.html

See package.json for the complete list

Cabin analytics

Analytics is only running on the read fieldnotes page https://withcabin.com/dashboard/ifieldnotes.org

CO2 emissions (online)

See: https://ifieldnotes.org/admin/sustainability.html

Robots

/robots.txt See: meta data for robots for read fieldnotes page

Sitemap

/sitemap.xml See: https://www.sitemaps.org/

Carbon emissions

/carbon.txt See: https://carbontxt.org/
See also: https://developers.thegreenwebfoundation.org/
NB: EmissionsTracker uses APIs provided by The Green Web Foundation

Green hosting

See: https://developers.thegreenwebfoundation.org/co2js/tutorials/getting-started-node/
Comment: Used in integration tests

Changelog

/CHANGELOG.md
See: https://keepachangelog.com/en/1.1.0/

Human readable HTML map

See: https://www.semrush.com/blog/html-sitemap/

Lighthouse

lighthouse https://ifieldnotes.org --budget-path=public/budgets/budget.json --output-path=./lighthouse/lighthouse-results.html

Site health

Netlify Status