diff --git a/profile/README.md b/profile/README.md index ee13cff..94a480c 100644 --- a/profile/README.md +++ b/profile/README.md @@ -10,38 +10,65 @@ ODE is a modular, open-source toolset engineered for development practitioners, ODE provides a complete solution for mobile-first data collection, designed to operate seamlessly in offline environments while maintaining robust synchronization capabilities. The platform emphasizes interoperability, extensibility, and a clean developer experience. +--- + ## Core Components -### Formulus +### [Formulus](https://github.com/OpenDataEnsemble/ode/tree/dev/formulus) -A mobile-first form engine built on [JSONForms](https://github.com/eclipsesource/jsonforms), optimized for field usability and offline operation. Formulus delivers an intuitive interface for data collection across Android and iOS devices. +A mobile-first form engine built on [JSONForms](https://github.com/eclipsesource/jsonforms), optimized for field usability and offline operation. Formulus delivers an intuitive interface for data collection across Android and iOS devices, designed specifically for real-world field constraints and challenging environments. -### Synkronus +### [Synkronus](https://github.com/OpenDataEnsemble/ode/tree/dev/synkronus) -The synchronization layer and backend API, engineered for offline resilience and seamless data flow. Synkronus handles data synchronization, storage, and provides the backbone for all data operations across the platform. +The synchronization layer and backend API, engineered for offline resilience and seamless data flow. Synkronus handles data synchronization, storage, and provides the backbone for all data operations across the platform. It's built for reliability in environments where connectivity may be intermittent. -### CLI & Development Tools +### [Synkronus CLI](https://github.com/OpenDataEnsemble/ode/tree/dev/synkronus-cli) Command-line utilities and development tools to help you develop, test, and manage your data collection workflows. Includes utilities for custom app data management, user administration, and data export capabilities. +--- + ## Key Features -- **Open Source & Community-Driven**: Built with transparency and community collaboration at its core -- **Field-Optimized**: Designed specifically for real-world field constraints and challenging environments -- **Interoperable & Extensible**: Built on open standards with a modular architecture for easy extension -- **Developer-Focused**: Clean APIs and comprehensive tooling for a superior development experience -- **Offline-First**: Robust offline capabilities with reliable synchronization when connectivity is restored +- **Open Source & Community-Driven**: Built with transparency and community collaboration at its core. The entire platform is FLOSS, giving you full control over your data collection infrastructure. + +- **Field-Optimized**: Designed specifically for real-world field constraints and challenging environments. ODE excels in situations where connectivity is unreliable or completely absent. + +- **Interoperable & Extensible**: Built on open standards with a modular architecture for easy extension. The platform is designed to integrate with your existing tools and workflows. + +- **Developer-Focused**: Clean APIs and comprehensive tooling for a superior development experience. Spend your time designing data collection instruments instead of building infrastructure. + +- **Offline-First**: Robust offline capabilities with reliable synchronization when connectivity is restored. Your data collection continues regardless of network conditions. + +- **Cross-Platform**: Available for both Android and iOS devices, ensuring broad accessibility across different hardware and operating systems. + +--- ## Getting Started -For detailed documentation, visit [opendataensemble.org](https://opendataensemble.org). +For detailed documentation, API reference, and technical overview, visit [opendataensemble.org](https://opendataensemble.org). -To explore individual components and begin development, check out the projects within this organization. +To explore individual components and begin development, check out the projects within this organization on GitHub. Each component has its own repository with documentation, issue tracking, and contribution guidelines. + +--- + +## Community + +The ODE Community is a space for developers, data scientists, researchers, and innovators to share knowledge, provide technical assistance, and explore new opportunities for learning and collaboration. + +- Join discussions on our [Community Forum](https://forum.opendataensemble.org) +- Explore our code and contribute on [GitHub](https://github.com/OpenDataEnsemble) + +The community features product updates and roadmaps, discussions about the resources included in ODE, technical support, and opportunities for collaboration. We invite you to join us and introduce yourself. + +--- ## Contributing ODE welcomes contributions from developers, researchers, and practitioners. Whether you're interested in software development, documentation, testing, or community building, there's a place for you in the ensemble. ---- +To get started, please review our [Contributing Guide](../CONTRIBUTING.md) for guidelines on code quality, documentation standards, and our commit message conventions. We also ask that all contributors adhere to our [Code of Conduct](../CODE_OF_CONDUCT.md) to maintain a welcoming and respectful community environment. + +Want to join us or build a new integration? Check out our GitHub repositories or join us on the Community Forum to share your ideas and questions. -*Building the future of open data collection, one contribution at a time.* +Building the future of open data collection, one contribution at a time.