An app to log data about your pets, including their health, activities, and more.

• Store information about your pets
• Track weight, medication and vaccinations
• Basic journalling features
• All data stored locally on device

To run the app you will need to install Flutter. Follow this Get Started guide.

• Clone the repository

git clone https://github.com/zjcz/petjournal.git

• Install the dependencies

flutter pub get

• Start the emulator or connect a device
• Run the application

flutter run

This app was originally intended for release on app stores. However, due to a change in personal circumstance I have decided to make the source code publically available. Feel free to fork the repo and build the app yourself for your own use. The app is in a work in progress state so is not production ready.

Uses the following packages:

• Drift for database management.
• fl_chart for charting. See Documentation for more information. Charts not implemented yet.
• flutter_riverpod for state management.
• go_router for routing / page navigation.

Github Copilot AI assistant was used initially when working on this project.

The project includes a .github/copilot-instructions.md file that contains instructions for the AI coding assistant. The instructions are designed to ensure that the code generated by the assistant follows the project's coding standards and best practices. The instructions cover general rules, UI design, and testing guidelines.

Context7 MCP server was used to provide the AI coding assistant with access to documentation for libraries like Flutter, Riverpod, Drift, and Mockito. The Context7 server is set up to provide the assistant with the latest documentation and examples for these libraries, ensuring that the code generated is up-to-date and follows best practices.

Finally, .github/flutter_dart_riverpod_mockito.md was included from flutter-ai-rules repository to provide additional context and rules for the AI coding assistant.

Later, Gemini CLI and Gemini Code Assist were used instead as the CLI seemed to generate better Flutter and Dart code in agent mode, with instructions added to the gemini.md file.

Placeholder Terms and Conditions and the Privacy Policy pages have been added to the app for production readiness. Once the app is finalised these can be generated at App Privacy Policy Generator

This project is licensed under the GNU General Public License v3.0 - see the license.md file for details.