Source Code

Welcome to the Unicis Source Code Handbook. This guide provides an overview of how we manage our source code across different repositories, both private and public. It covers the structure, guidelines, and best practices for contributing to the Unicis Platform.

Unicis manages two separate sets of repositories:

• Private Repositories: Hosted on GitLab, containing proprietary source code for Unicis Platform Business Edition, Unicis Apps, website, and this handbook.
• Public Repository: Hosted on GitHub, containing the open-source code for the Unicis Platform Community Edition.

Our private repositories are used for internal development and contain sensitive, proprietary code. These repositories are not open to the public.

The Business Edition of the Unicis Platform includes enterprise features and custom integrations.

unicis-platform
├── components
├── data
├── hooks
├── lib
└── locales/en
└── models
└── pages
└── prisma
└── public
└── style
└── test/e2e/auth
└── types

Access to this repository is restricted to authorized personnel. Ensure you have the necessary permissions to clone and contribute to this repository.

• Branching Strategy: Use a Git branching strategy such as GitFlow.
• Commit Messages: Follow the commit message guidelines to ensure clarity and consistency.
• Code Reviews: All changes must go through a code review process before being merged.

This repository contains the source code for various applications developed using the Atlassian Forge framework.

unicis-apps
├── app1
├── app2
├── common
└── README.md

• Modular Structure: Each application should be developed as a separate module within the repository.
• Dependency Management: Ensure all dependencies are properly documented and managed.

This repository hosts the source code for the Unicis website.

website
├── blog
├── docs
├── resources
├── src
├── static
├── versioned_docs
├── versioned_sidebars

• Website: Deployed using Docusaurus framework.

This repository hosts the source code for the Unicis handbook.

unicis-handbook
├── archetypes
├── assets
├── content
├── layouts/partials/docs
├── layouts/_gen/assets
├── static
├── themes

• Handbook: Managed and deployed using DokuWiki.

Our public repository on GitHub is open for contributions from the community. This repository contains the Community Edition of the Unicis Platform.

The Community Edition is a feature-limited version of the Unicis Platform, designed to be open and extensible.

unicis-platform-ce
├── components
├── data
├── hooks
├── lib
└── locales/en
└── models
└── pages
└── prisma
└── public
└── style
└── test/e2e/auth
└── types

The repository is public and can be accessed by anyone at: Unicis Platform Community Edition.

We welcome contributions from the community. Please follow the guidelines outlined in the Contribution Guide.

• Fork the Repository: Create a fork of the repository to make your changes.
• Create a Branch: Use a descriptive branch name for your feature or bug fix.
• Pull Requests: Submit a pull request with a detailed description of your changes.
• Code of Conduct: Adhere to the community Code of Conduct.

• Consistent Coding Standards: Follow the coding standards specified in the repository.
• Documentation: Keep documentation up-to-date with code changes.
• Testing: Write unit and integration tests for your code.
• Security: Regularly review and update dependencies to address security vulnerabilities.

• Access Issues: Ensure you have the correct permissions for private repositories.
• Build Failures: Check CI/CD pipeline logs for errors and address them accordingly.
• Merge Conflicts: Resolve conflicts by pulling the latest changes and merging them into your branch.

• Logs: Review logs for any runtime errors or warnings.
• Documentation: Refer to repository documentation and community forums for solutions.

• GitLab Documentation: GitLab Docs
• GitHub Documentation: GitHub Docs
• Unicis Community: Unicis Community

By following this handbook, you will be well-equipped to manage and contribute to the Unicis Platform effectively. For any further assistance, please reach out to the DevOps team or consult the provided resources.