Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
meta-d committed Dec 12, 2023
2 parents e4f21e4 + b468ef7 commit 8eb07d2
Show file tree
Hide file tree
Showing 757 changed files with 89,285 additions and 91 deletions.
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# 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, 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 behavior 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 behavior 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
service@mtda.cloud.
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 behavior.

**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.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
31 changes: 31 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing to Metad Platform

We would love for you to contribute to Metad Platform!

## Submitting Pull Requests

If you're changing the structure of the repository please create an issue first.

By default, when you submitting contributions with Pull Requests, we require electronic submission of individual [Contributor Assignment Agreement (CAA)](https://gist.github.com/evereq/95f74ae09510766ffa9379006715ccfd). In some cases (when contributions are very small, at our discretion) instead of CAA we may accept submission of individual [Contributor License Agreement (CLA)](https://gist.github.com/evereq/53ddec283243481344fb61df1706ec40).

If you submitting contribution on behalf of some legal entity, you need to submit Entity Contributor Assignment Agreement (CAA) or Entity Contributor License Agreement (CLA), which you can request by sending us an email to service@mtda.cloud.

We are using open-source [CLA assistant](https://github.com/cla-assistant/cla-assistant) project to collect your signatures on CAA.
The templates for our CAA/CLA documents generated by http://www.harmonyagreements.org.

## Submitting bug reports

Make sure you are on latest changes.
If you can, please provide more information about your environment such as browser, operating system, node version, and yarn version.

## Feature requests+

You are more than welcome to submit future requests here https://github.com/meta-d/sap-fiori-templates/issues

## Legal

This is an open source project.
Contributions you make to this public Metad Platform repository are completely voluntary.
When you submit an issue, bug report, question, enhancement, pull request, etc., you are offering your contribution without expectation of payment, you expressly waive any future pay claims against the Metad Co. LTD related to your contribution, and you acknowledge that this does not create an obligation on the part of the Metad Co. LTD of any kind. Furthermore, your contributing to this project does not create an employer-employee relationship between the Metad Co. LTD and the contributor.

See also "Submitting Pull Requests" section above for more information on CAA/CLA, required for any contributions.
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# PR

- [ ] Have you followed the [contributing guidelines](https://github.com/meta-d/sap-fiori-tempaltes/blob/main/.github/CONTRIBUTING.md)?
- [ ] Have you explained what your changes do, and why they add value?

**Please note: ✅ we will close your PR without comment if you do not check the boxes above and provide ALL requested information.**

---
33 changes: 33 additions & 0 deletions .github/workflows/publish-npm-cap-odata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Publish Package to npmjs

on:
push:
tags:
- '*'
branches:
- 'main'
paths:
- "btp-cap-monorepo/**"

jobs:
build:
runs-on: ubuntu-latest
environment:
name: Prod
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.ref_name }}
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v3
with:
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
- run: yarn
working-directory: ./btp-cap-monorepo
- run: yarn nx build odata
working-directory: ./btp-cap-monorepo
- run: npm publish --access public --tag latest
working-directory: ./btp-cap-monorepo/dist/packages/odata
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<h1 align="center">SAP Fiori App Templates</h1>
<h1 align="center">SAP BTP & Fiori App Templates</h1>

<p align="center">
<a href="https://angular.dev/"><img alt="angular-logo" width="300px" valign="middle" src="./docs/images/angular_wordmark_gradient.png"></a><a href="https://vuejs.org/"><img width="100px" valign="middle" src="./docs/images/vue.png"></a>
<a href="https://cap.cloud.sap/"><img alt="sap-cap-logo" width="100px" valign="middle" src="./docs/images/cap.svg"></a>
</p>
<p align="center">
<a title="Ant Design" href="https://ant-design.antgroup.com/index-cn"><img width="80px" valign="middle" src="./docs/images/ant-design.svg"></a>➕<a title="SAP Fiori Design" href="https://experience.sap.com/fiori-design-web/"><img width="100px" valign="middle" src="./docs/images/sap.png"></a>
</p>
<p align="center">
<em>This workspace contains multiple development templates for building mobile and desktop SAP Fiori applications
<br> using Angular, Vue, React frameworks and Ant Design.</em>
<em>This workspace contains multiple development templates for building mobile and desktop SAP BTP & Fiori applications
<br> using <b>Angular</b>, Vue, React frameworks and <b>Ant Design</b>.</em>
<br>
</p>

Expand All @@ -21,9 +22,9 @@

## 🌟 What is this?

This is a collection of SAP Fiori application templates built by third-party front-end frameworks (Vue, Angular, React, etc.). It is based on [Nx](https://nx.dev) and [UI5 Tooling](https://sap.github.io/ui5-tooling/).
This is a collection of SAP BTP & Fiori application templates built by third-party front-end frameworks (Angular, Vue, React, etc.). It is based on [Nx](https://nx.dev) and [UI5 Tooling](https://sap.github.io/ui5-tooling/).

There are several advantages to using open-source frameworks to create Fiori applications:
There are several advantages to using open-source frameworks to create BTP & Fiori applications:

* A robust ecosystem and active developer community that provide solutions, sample code, and plugins.
* Rich component libraries and templates.
Expand All @@ -36,13 +37,14 @@ There are several advantages to using open-source frameworks to create Fiori app

## 📄 How to use

You can download the template under this code repository and then modify and deploy it, or you can build a project from scratch according to our creation steps.
You can download the templates under this code repository and then modify and deploy it, or you can build a project from scratch according to our creation steps.

We plan to provide project templates in multiple frameworks and multiple combinations. The templates that have been developed can all be used.

* ⭐️ [BTP CAP Angular workspace](./btp-cap-monorepo/)
* [Angular standalone workspace](./angular-standalone/)
* [Vue standalone workspace](./sap-fiori-vue-standalone/)
* React standalone workspace
* [React monorepo workspace](./react-monorepo)

## ✨ Features

Expand All @@ -63,7 +65,10 @@ We plan to provide project templates in multiple frameworks and multiple combina
* Website **watermark** functionality.
* Global application **search** feature.
* **Full-screen** mode for web pages and Fiori applications.
* **Tabs** page management.
* Functional [OData client library](./btp-cap-monorepo/packages/odata/).
* Support for SAP system [**notification**](./docs/Notification.md) messages.
* [Embedded Analytics](./docs/BI.md) using [OCAP framework](https://github.com/meta-d/ocap).

## 🌼 Screenshots

Expand Down Expand Up @@ -94,6 +99,10 @@ We plan to provide project templates in multiple frameworks and multiple combina

<img src="./docs/images/internationalization.png" alt="Internationalization Screenshot" height="auto" width="100%" style="border-radius: 10px;">

### Embedded Analytics

<img src="./docs/images/bi/ocap-schema.png" alt="Embedded Analytics Screenshot" height="auto" width="100%" style="border-radius: 10px;">

</details>

## 🧱 Best practices
Expand Down
24 changes: 17 additions & 7 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<h1 align="center">SAP Fiori 应用模版</h1>
<h1 align="center">SAP BTP & Fiori 应用模版</h1>

<p align="center">
<a title="Angular" href="https://angular.dev/"><img alt="angular-logo" width="300px" valign="middle" src="./docs/images/angular_wordmark_gradient.png"></a><a title="Vuejs" href="https://vuejs.org/"><img width="100px" valign="middle" src="./docs/images/vue.png"></a>
<a href="https://cap.cloud.sap/"><img alt="sap-cap-logo" width="100px" valign="middle" src="./docs/images/cap.svg"></a>
</p>
<p align="center">
<a title="Ant Design" href="https://ant-design.antgroup.com/index-cn"><img width="80px" valign="middle" src="./docs/images/ant-design.svg"></a>➕<a title="SAP Fiori Design" href="https://experience.sap.com/fiori-design-web/"><img width="100px" valign="middle" src="./docs/images/sap.png"></a>
</p>
<p align="center">
<em>此工作空间包含多个开发模板用于构建移动和桌面 SAP Fiori 应用程序
<br>使用 Angular、Vue、React 等框架和 Ant Design 设计规范</em>
<em>此工作空间包含多个开发模板用于构建移动和桌面 SAP BTP & Fiori 应用程序
<br>使用 <b>Angular</b>、Vue、React 等框架和 <b>Ant Design</b> 设计规范</em>
<br>
</p>

Expand All @@ -21,8 +22,9 @@

## 🌟 这是什么?

这是一个由第三方前端框架(Angular、Vue、React等)构建的 SAP Fiori 应用程序模板集合。它基于 [Nx](https://nx.dev)[UI5 Tooling](https://sap.github.io/ui5-tooling/)
使用开源框架来创建 Fiori 应用有很多优势:
这是一个由第三方前端框架(Angular、Vue、React等)构建的 SAP BTP & Fiori 应用程序模板集合。它基于 [Nx](https://nx.dev)[UI5 Tooling](https://sap.github.io/ui5-tooling/)

使用开源框架来创建 BTP & Fiori 应用有很多优势:
* 强大的生态系统和活跃的开发社区,提供了问题解决方案、示例代码和插件。
* 丰富的组件库和模板。
* 跨平台一致性,支持响应式设计,使应用程序能够适应不同的屏幕尺寸和设备。
Expand All @@ -38,9 +40,10 @@

我们计划提供多个框架和多种组合的项目模板。已开发的模板都可以使用。

* ⭐️ [BTP CAP Angular workspace](./btp-cap-monorepo/)
* [Angular standalone workspace](./angular-standalone/)
* [Vue standalone workspace](./sap-fiori-vue-standalone/)
* React standalone workspace
* [React monorepo workspace](./react-monorepo)

## ✨ 功能特性

Expand All @@ -61,7 +64,10 @@
* 网站**水印**功能。
* 全局应用**搜索**功能。
* 网页和 Fiori 应用**全屏**功能。
* 支持 SAP 系统 [**通知**](./docs/zh/Notification.md)消息。
* **选项卡** 式页面管理。
* 函数式 [OData 客户端库](./btp-cap-monorepo/packages/odata/)
* 支持 SAP 系统 [**通知**](./docs/Notification.md) 消息。
* [嵌入式分析](./docs/BI.md) 使用 [OCAP 框架](https://github.com/meta-d/ocap).

## 🌼 屏幕截图

Expand Down Expand Up @@ -92,6 +98,10 @@

<img src="./docs/images/internationalization.png" alt="Internationalization Screenshot" height="auto" width="100%" style="border-radius: 10px;">

### 嵌入式分析

<img src="./docs/images/bi/ocap-schema.png" alt="Embedded Analytics Screenshot" height="auto" width="100%" style="border-radius: 10px;">

</details>

## 🧱 最佳实践
Expand Down
4 changes: 2 additions & 2 deletions angular-standalone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Add storybook use command `npx nx g @nx/angular:storybook-configuration angular-
You can execute the following npm scripts to preview the application:

* **start** - starts the application with real service data.
* **start-mock** - starts the application with mock data.
* **start:mock** - starts the application with mock data.

### 📡 Use Live Data

Expand All @@ -79,7 +79,7 @@ Here is the configuration file *src/proxy.conf.json*, all the requests starting

### 📋 Use Mock Data

When using `npm run start-mock` to start the application and a mock server to reflect the OData endpoint, you can use the application without having to connect to a live OData service and generate mock data on the fly.
When using `npm run start:mock` to start the application and a mock server to reflect the OData endpoint, you can use the application without having to connect to a live OData service and generate mock data on the fly.

### Add New OData Mock Data

Expand Down
4 changes: 2 additions & 2 deletions angular-standalone/README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
您可以执行以下 npm 脚本预览应用程序:

* **start** - 以真实服务数据启动应用程序。
* **start-mock** - 以模拟数据启动应用程序。
* **start:mock** - 以模拟数据启动应用程序。

### 📡 使用在线数据

Expand All @@ -80,7 +80,7 @@

### 📋 使用模拟数据

当使用`npm run start-mock` 来运行应用程序和模拟数据服务器来模拟 OData 端点时,您可以在不连接到实时 OData 服务的情况下使用应用程序,并即时生成模拟数据。
当使用`npm run start:mock` 来运行应用程序和模拟数据服务器来模拟 OData 端点时,您可以在不连接到实时 OData 服务的情况下使用应用程序,并即时生成模拟数据。

### 添加新 OData 的模拟数据

Expand Down
Loading

0 comments on commit 8eb07d2

Please sign in to comment.