potato_api

Potato API

Twirp definition for Potato.

Important links

• Documentation page
• Project page
• Technical specification doc

Specific sections inside the documentation page:

• Setup?
• Quickstart
• Onboarding guide
• Testing locally
• Testing via dev stack
• Deploying to production
• Runbook
• API
• Technical specification (generated)
• Private workflow: https://turnipxenon.github.io/cornmaze/private_workflow/
• Code standards: https://turnipxenon.github.io/cornmaze/code_standards/

Contributing to README.md

Do not edit ./README.md! Instead, edit ./docs/docs/index.md.

Requirements:

• You need Go >=1.17 installed.
• Run go install github.com/TurnipXenon/cornmaze/dev/sync_readme@latest

Command:

After editing that file, run go get github.com/TurnipXenon/cornmaze/dev/sync_readme from the root folder /. That should automatically transform all the relative references.