🌍 Open Source Community

Getting Started with the Cypht Community

Welcome! We're excited to have you join us. Whether you're a developer, designer, or documentation writer, there's a place for you in the Cypht community.

About the Community

What is Cypht?

Cypht is an Open Source email client and news aggregator with a modular design. Unlike traditional applications, Cypht is built entirely from plugins (called "module sets"), with core modules being essential. Users can customize their experience by adding or replacing modules to suit their needs.

Our Values

As a community, we prioritize collaboration, inclusivity, and transparency. We encourage respect for others and open communication. Our goal is to create a welcoming environment for all contributors, regardless of experience level.

Join Us

Getting Involved

Connect on Gitter

Reach out, ask questions, and connect with other community members on our Gitter channel.

Open Gitter

Contribute on GitHub

Browse issues, submit pull requests, and help improve the codebase directly on GitHub.

Open GitHub

Read the Docs

Read the official documentation to understand how Cypht works before contributing.

Read Docs
Setup

Setting Up Your Environment

Before contributing to Cypht, you'll need to set up your development environment with the following tools:

  • A code editor of your choice (e.g., VSCode, Sublime Text)
  • Git for version control
  • PHP for developing Cypht
  • A web server (e.g., Apache, Nginx) for testing

For full installation, configuration, and setup instructions, visit the Installation Guide.

Guidelines

Contributing to Cypht

When contributing to Cypht, please follow our community contribution guidelines. This ensures a smooth collaboration experience for everyone.

Don't hesitate to ask for help or guidance. We have experienced community members who are happy to mentor and support newcomers.