Home

Welcome! Kindly find an overview below and you can navigate to the relevant section on the table of context bar on the right --> Please open an issue should you want to contribute wiki documentation or update anything not accurate. Thanks!

0. Migration Guide A step by step guide on how to migrate from the upstream project to streamlit-analytics2, which addresses security issues and other improvements.

1. [Getting Started]

   Introduction: Brief overview of streamlit-analytics2, its purpose, and key features.
   Installation: Step-by-step instructions on how to install streamlit-analytics2 using pip.
   Quick Start Guide: A simple example to get users up and running with basic functionality.

2. [Advanced Configuration]

   Custom Tracking: How to implement custom tracking beyond the default setup, including tracking specific widgets and actions.
   Password Protection: Detailed setup for adding password protection to analytics results.
   Firestore Integration: Instructions for setting up Firestore for persistent storage of analytics data.
   JSON Storage: Guide on how to save and load analytics data using JSON files.

3. [FAQs] - Coming soon

   Address common questions and troubleshooting tips regarding installation, usage, and configuration.

4. Contributing

   Guidelines on how to contribute to streamlit-analytics2, including how to submit pull requests, report bugs, and suggest features.

5. Security

   Explanation of the project's security practices, how to report security vulnerabilities, and the policy for addressing them.