Roadmap

[liammulh]

✅ Scaffold basic CRUD application (~1 month)

• Used built in Django CRUD.

Follow https://hypermedia.systems as a guide.

Add user authentication (~1 week)

• Used built in Django user authentication.
• Schedule meeting with Matt about login.
• Use GCI/VCI's user authentication system #40
• boto3 Credentials
• boto3 CognitoIdentityProvider
• boto3 initiate_auth
• boto3 get_user

✅ Add JSON data API for other applications to CRUD affiliations (~1 week without the OpenAPI)

• Guide to creating a good JSON data API

Deploy test instance to on-prem server (~1 week)

• See DevOps for the Desperate: A Hands-On Survival Guide. (Ask me about this.)
• Create plan for configuring server using Ansible
• Create plan for deploying to the server via Ansible

Deploy production instance to AWS (~2 weeks)

• Talk to Ryan about using Lightsail
• Use Lightsail Ubuntu VPS?
• Create plan for configuring server via Ansible
• Create plan for deploying to the server via Ansible

Conform to Gecko best practices (~1 week)

See the best practices spreadsheet here.

• Create GitHub Actions workflow for code checks #3
• Diagram current and desired affiliations workflow #10
• Allow different configs for different machines #12
• Remove code and configuration related to Elastic Beanstalk #16
• Create a set of agreed-upon standards for code that is submitted to the main branch #18
• Write UI tests for important bits of UI
  • Since we're not using a front end framework, we're just testing that certain important bits of HTML are in the response.
• Configure dependabot for alerts and auto-updates #23
• Make GitHub Actions use Pipenv for installing dependencies #28
• Create a Python style guide #31
• Check this checkbox once you have IaC set up
• Set up AWS monitoring
• Set up AWS backups
• Create system for managing secrets
• [ ] Collect metrics
• Add GitHub Actions CI badge to README #19
• Add OpenSSF badge to README #20
• Work on OpenSSF compliance #21

Set up documentation system

• Add documentation organization system #14
• Remove reference doc #17

Use production data (~1 week)

• Discuss using correct status for affiliations

Miscellaneous small tasks (~1 week)

• Add more to the explanation of environment variables (make sure to link to the Twelve-Factor App docs)
• Add contributing guidelines
• Add an explanation for using Invoke #172
• Document squash-and-merge for PRs #170
• Document Conventional Commits #167
• Add instruction to install yamlfmt to getting started instructions #39
• Ideate on new ID system #73
• Make Admin page the homepage. #89
• Look into Admin page theme/customize styling. #95
• Create different Admin users based on permissions. #85
• Protect main branch #91
• Add logging to different functionality/Audit trail. #92
• What is the model for an affiliation.
• Make changes from feedback 7/9. #84
• Change from Flask to Django. #83
• Get member information and updates from API (GPM and GCI/VCI) #102

Questions

• What sort of permissions should there be for the browsable API? #86
• Should we use API tokens? #87
• Should we version our API? #88