Home - jbrucker/home-log GitHub Wiki

An application to record numerical data for things related to a residence, such as readings on an electric meter and water meter. Anything with a date and numeric value.

A secondary purpose of this project is to explore different database and deployment alternatives, and how they effect the application design and implementation.

• Vision
• Requirements
• Architecture
• Domain Model
• Server Side Software Design
• Front-End Web Application Design
• Deployment

Development

• Project Plan as a Github Project
• Database Schema
• Web Server and Application Server for back-end
• Data Access Objects or Data Access Operations?
• Data Access Operations
• FastAPI Programming Notes
• JWT Access Token
• Monitoring
• Visualization using Grafana with links to tutorial(s)
• Logging

Deployment

• Application Hosting
• Database Alternatives and Hosting

Testing

How to Setup Memory Database Test with Pytest and SqlAlchemy on Medium.com

References

• Microsoft Azure REST API Guidelines detailed guidance for designing a REST API. In particular, explains when to return various status codes.
• Microsoft Considerations for Service Design