Welcome to the Caelium project! We’re thrilled that you're interested in contributing to our vision of a unified, socially immersive digital platform. This guide will help you get familiar with our project structure, code of conduct, and guidelines for contributing to ensure a smooth start.
Caelium is divided into two primary repositories:
- caelium: This repository contains the backend code, developed using Django. It manages API services and core functionalities.
- caelium-next: This repository houses the frontend code, built with Next.js. It provides the Progressive Web App (PWA) interface and user interactions.
Note
The frontend interface in caelium-next is dependent on the backend API in caelium. Ensure that the backend is running for the frontend to function correctly.
Each repository has its own docs folder and README file containing setup and development instructions, so you can dive into either the backend or frontend development based on your expertise.
For specific setup instructions, please refer to the documentation in each repository:
By following these instructions, you’ll be able to get the required dependencies installed and start running Caelium locally.
We’re committed to maintaining high standards and a collaborative environment. Before contributing, please review our Contributing Guidelines for information on how to structure your contributions, open issues, and submit pull requests.
Important
Please Note: By contributing to Caelium, you agree to our Contributor License Agreement (CLA), confirming you have the right to contribute and granting us permissions to use your contributions within the project.
To ensure a respectful and inclusive environment, all contributors are expected to adhere to our Code of Conduct. It provides clear guidelines for interactions within our community to foster collaboration and mutual respect.
Caelium is open-source software licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This license requires that any modifications made to Caelium must be open-sourced when distributed over a network, helping keep the project community-focused and freely accessible.
Note
Please make sure any contributions comply with the AGPL-3.0 license requirements, keeping our project open-source and encouraging contributions that benefit everyone.
For more information, please refer to the following resources:
We’re excited to see your contributions and look forward to building Caelium together!