Skip to main content

Plum Village App Dev Docs

Welcome to the developer documentation for the Plum Village App, a mobile application supporting mindfulness and meditation practices in the tradition of Thich Nhat Hanh and Plum Village.

About the Project

The Plum Village App provides guided meditations, teachings, and mindfulness resources to practitioners worldwide. This documentation serves as a comprehensive guide for developers contributing to the project.

The documentation covers code in many repositories, some of which are private. The documentation is therefore not yet useful for the general public, but we hope it will be more useful in the future once we make more of the code public.

Contributing

To contribute to these docs:

  1. Check out the source code: Visit our GitHub repository
  2. Set up locally: Follow the installation instructions in the README
  3. Explore the docs: Browse through the documentation sections
  4. Contribute: Submit issues or pull requests to help improve the documentation

As this project is public, please do not include any sensitive information or private code in your contributions.

Support

For questions or issues, please create an issue in our GitHub repository.

License

© 2025 Center For Applied Ethics Ltd.

This documentation is licensed under the Creative Commons Attribution 4.0 International License. You are free to share and adapt this material for any purpose, even commercially, as long as you provide appropriate attribution to the Center For Applied Ethics Ltd.