Getting Started with Cypht Community

Introduction

Welcome to the Cypht community! We are excited to have you join us and become a part of our mission to develop and improve Cypht. This documentation is designed to help you get started with our community, understand the development process, and contribute effectively to the project.

About the Cypht 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, or "module sets," with the core modules being essential. Users can customize their experience by adding or replacing modules to suit specific site requirements. This modular approach offers flexibility and easy customization, although it may introduce complexity.

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 developers, regardless of experience levels.

Joining the Community

Getting Involved

To start your journey with the Cypht community, Connect with us on gitter.

Setting up Your Development Environment

Tools and Software

Before you can contribute to Cypht, you need to set up your development environment. You will need the following tools and software:

  • 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

Configuration and Setup

For installation, configuration, and setup, please check the installation page

Contributing to Cypht

When contributing to Cypht, follow these practices

Community Resources

For more information and resources, explore the following:

Don't hesitate to ask for help or guidance. We have experienced community members who are willing to mentor and support newcomers. Feel free to reach out on Gitter.