contribute

PhyloPic Contribution Webapp

This Next.js application allows users to upload silhouette images to PhyloPic.

The app is hosted at https://contribute.phylopic.org.

Getting started

See instructions in the PhyloPic project README for setting up the monorepo project.

Environment variables

The following environment variables are required. They may be stored in .env.local in the root of this project, when running the project locally.

Variable Name	Description
AUTH_SECRET_KEY	Secret key used for authentication
NEXT_PUBLIC_API_URL	Root URL of the PhyloPic API (https://api.phylopic.org)
NEXT_PUBLIC_CONTRIBUTE_URL	Root URL of the PhyloPic: Contribute website (https://contribute.phylopic.org)
NEXT_PUBLIC_WWW_URL	Root URL of the main PhyloPic website (https://www.phylopic.org)
PGHOST	Postgres host
PGPASSWORD	Postgres password
PGUSER	Postgres user
S3_ACCESS_KEY_ID	Amazon Web Services S3 access key ID
S3_REGION	Amazon Web Services S3 region
S3_SECRET_ACCESS_KEY	Amazon Web Services S3 secret access key
SES_ACCESS_KEY_ID	AWS SES access key ID
SES_REGION	AWS SES region
SES_SECRET_ACCESS_KEY	AWS SES secret access key

The following environment variables are optional:

Variable Name	Description
NEXT_PUBLIC_EOL_API_KEY	Encyclopedia of Life API key
NEXT_PUBLIC_GOOGLE_MEASUREMENT_ID	Measurement ID for Google Analytics
PGPORT	Postgres port (default: 5432)

Linting

To clean up formatting for source files:

yarn lint

Running locally

To run a development version on your local machine, on port 3002:

yarn dev

To run the production version locally, on port 3000:

yarn build && yarn start

Deploying

To deploy to contribute.phylopic.org, use Git to set the @phylopic/contribute/prod branch to the desired commit, then push to origin.

git push origin @phylopic/contribute/prod

The app will deploy through Vercel.

Authors

• T. Michael Keesey - keesey

License

This project is licensed under the MIT License.