Welcome to Pentameter’s documentation!

Pentameter.org documentation for working with the backend and frontend codebases in order to develop and maintain the code to run the site.

Continue to Foreword, or Installation, or the Quickstart.

Project Guide

Getting the project set up and general guidance on how to work with the code from development to deploying.

• Foreword
• Installation
• Quickstart
  • Python Flask App
  • React Front End
• Config
• Testing
• Gitflow
  • Workflow
  • Feature Branches
  • Rebasing
  • Pull Requests
• Deploying
  • Staging
  • Production

API Reference

Information on the backend API that is used by the front end.

• API
  • Overview
  • Response Types
  • Endpoints

Frontend Reference

Information on setting up and developing the frontend React application which uses the API to display the interface on web and mobile.

• Front End

Additional Notes

Legalese and general information

• Changelog
• License