Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 133 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behaviour that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behaviour that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[codeofconduct@webifycms.com](mailto:codeofconduct@webifycms.com).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behaviour.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
100 changes: 100 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# 👋 Hey there, fellow contributor

> Thank you for being here and considering a contribution to WebifyCMS!
> Together we can make great software.

---

## ⚖️ Developer Certificate of Origin (DCO)

To keep WebifyCMS open, secure, and legally clean, we use a **Developer Certificate of Origin (DCO)**
instead of a complex contributor agreement.

By contributing to this project, you certify that you have the right to submit the code
under the project's open-source license.

### How to Sign Your Work
All you need to do is sign off on your git commits.
You can do this automatically by adding the `-s` flag when you commit:

```bash
git commit -s -m "Your meaningful commit message"
```

This automatically appends a line to your commit message like this:
`Signed-off-by: Your Name <your.email@example.com>`

*Note: Pull Requests with unsigned commits cannot be merged. If you forget to sign a commit,
you can fix it using `git commit --amend -s` before pushing.*

---

## 🛠️ Let's Set Up for Development

### Prerequisites

* An environment capable of running Docker or Docker Desktop.

### 1. Installation

Clone the main repository and use the [WebifyCMS Installer](https://github.com/webifycms/installer)
package to initialize the local stack setup.

### 2. Environment Configuration

Navigate to your application `app` directory and copy the sample environment file:

```bash
cd app && cp .env.sample .env
```

Open the newly created `.env` file and adjust the values for your local setup.
Ensure the environment variables are configured for local debugging:

* `APP_ENVIRONMENT='development'`
* `APP_DEBUG=true`

Add your configured `APP_BASE_URL` value to your local system's host file if you are using a custom local domain.

At this stage, your local folder structure should match this layout:

```
.
└── webifycms-stack/
├── app/
│ ├── ...
│ ├── .env
│ ├── .env.sample
│ ├── composer.json
│ ├── composer.lock
│ ├── src/
│ ├── extensions/
│ ├── themes/
│ ├── vendor/
│ └── ...
├── extensions/
│ └── ext-base/
└── themes/
└── theme-canvas/
```

### 3. Install Dependencies

Switch to your working branches inside the `app` and `extensions` directories, then install the PHP packages:

```bash
php composer install
```

### 4. Run the Application

You can spin up the application quickly using PHP's built-in development web server:

```bash
php -S localhost:8000 -t public/
```

The application will now be available in your browser at `http://localhost:8000`.

> 💡 **Note:** The built-in PHP server is single-threaded and intended strictly for local development.
> Use a dedicated web server like Nginx, Apache, or Caddy for production deployments.
14 changes: 14 additions & 0 deletions .github/workflows/pull-request-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Pull Request Checks

on:
push:
branches:
- main
pull_request:

jobs:
pr-check:
uses: webifycms/github/.github/workflows/pull-request-checks.yml@main
with:
php-version: '8.4'
composer-version: 'v2'
19 changes: 19 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# phpstorm project files
/.idea

# vscode project files
/.vscode

# windows thumbnail cache
Thumbs.db

# composer
/vendor/
composer.phar

# Mac DS_Store Files
.DS_Store

# ignores the cache files
.php-cs-fixer.cache
/.phpunit.cache
5 changes: 5 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

55 changes: 55 additions & 0 deletions .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?php

/**
* The file is part of the "webifycms/ext-user", WebifyCMS extension package.
*
* @see https://webifycms.com/extension/user
*
* @copyright Copyright (c) 2023 - Present WebifyCMS
* @license https://webifycms.com/license
* @author Mohammed Shifreen <mshifreen@gmail.com>
*/
declare(strict_types=1);

// should require the composer autoloader on first
require __DIR__ . '/vendor/autoload.php';

use PhpCsFixer\Finder;
use Webify\Tools\Fixer\Fixer;

$finder = Finder::create()
->in(__DIR__)
->exclude(
[
'vendor',
]
)
->ignoreDotFiles(false)
->name('*.php')
;
$header = <<<'HEADER'
The file is part of the "webifycms/ext-user", WebifyCMS extension package.

@see https://webifycms.com/extension/user

@copyright Copyright (c) 2023 - Present WebifyCMS
@license https://webifycms.com/license
@author Mohammed Shifreen <mshifreen@gmail.com>
HEADER;
$rules = [
'header_comment' => [
'header' => $header,
'location' => 'after_open',
'comment_type' => 'PHPDoc',
'separate' => 'top',
],
'php_unit_test_class_requires_covers' => false,
'class_definition' => [
'multi_line_extends_each_single_line' => true,
],
];

return new Fixer($finder, $rules)
->getConfig()
->setUsingCache(false)
;
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# WebifyCMS License

Copyright &copy; 2023 WebifyCMS (<https://www.webifycms.com>)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading
Loading