Skip to content

.NET + Vue.jsのシステム開発で利用可能なドキュメントとサンプルを提供します。

License

CC-BY-4.0, Apache-2.0 licenses found

Licenses found

CC-BY-4.0
LICENSE
Apache-2.0
LICENSE-CODE
Notifications You must be signed in to change notification settings

AlesInfiny/maris

AlesInfiny Maris OSS Edition

AlesInfiny Maris OSS Edition は現代の .NET システム開発において標準的なアプリケーションアーキテクチャを提供します。 商用のエンタープライズシステム開発から個人開発の小規模なシステムまで、 無償で利用可能です。

Getting Started

AlesInfiny Maris OSS Edition は、以下の Web サイトを通じて最新バージョンを公開しています。 ドキュメントの閲覧やサンプルアプリケーションのダウンロードは、 Web サイトから行ってください。

https://maris.alesinfiny.org/

ローカル開発環境

ドキュメントやサンプルアプリケーションの開発には VS Code と Visual Studio を使用します。 いずれも最新のバージョンをインストールしてください。

ドキュメント開発環境

ドキュメント開発環境の構築手順は以下を参照してください。

サンプルアプリケーション、要件別サンプル開発環境

サンプルアプリケーションや要件別サンプルの開発環境は、 Visual Studio と VS Code を推奨します。 バックエンドアプリケーションの開発には Visual Studio を、フロントエンドアプリケーションの開発には VS Code を使用します。

開発環境の構築手順は以下を参照してください。

サンプルアプリケーションのテスト

.NET アプリケーション

.NET アプリケーションは、 Visual Studio のテストランナー、または dotnet コマンドでテストできます。

テストには、メソッドレベルでの動作を確認する単体テストと、 Web API レベルでの動作を確認する結合テストがあります。 いずれのテストも完全に自動化されています。 またテストフレームワークには xUnit.net を使用しています。

Visual Studio を利用してテストを実行する場合は、 Visual Studio のテストエクスプローラーからテストを実行します。

dotnet コマンドを利用してテストを実行する場合は、ソリューションファイルの存在するフォルダーで以下のコマンドを実行します。

dotnet test

サンプルアプリケーションは、テストの実装方式を説明する目的で構築されており、すべての仕様に対してテストが実装されているとは限りません。

Vue.js アプリケーション

Vue.js アプリケーションは、 Vitest でテストできます。 Vue.js アプリケーションのルートディレクトリから、以下のようなコマンドを実行します。

npm run test:unit:consumer

test:unit:consumer の部分は、 package.json に定義されているスクリプト名と一致させます。 実行するテストの対象によって、スクリプト名を変更してください。

サンプルアプリケーションは、テストの実装方式を説明する目的で構築されており、すべての仕様に対してテストが実装されているとは限りません。

ローカル開発環境での閲覧と実行

ドキュメント

ドキュメントの開発には Python と MkDocs を使用します。 詳細は AlesInfiny Maris OSS Edition ドキュメントについて | 動作確認 を参照してください。

ただし、ローカル開発環境での実行では、サンプルアプリケーションのダウンロードリンクなど、一部が動作しません。

サンプルアプリケーション(Dressca)

サンプルアプリケーション (Dressca) の実行手順は AlesInfiny Maris OSS Edition | クイックスタート を参照してください。

要件別サンプル

各要件別サンプルのフォルダーに配置されている README.md を参照してください。

本番配置向けドキュメントのビルドと配置

本番配置向けドキュメントのビルドは、 GitHub Actions を利用します。 「ドキュメントのビルドとリリース」のワークフローを実行してください。 正常にビルドできると、配置するモジュールが Artifacts に「documents」という名前で格納されます。 このファイルをダウンロードして展開し、 Web サーバー (IIS) に配置してください。

なお AlesInfiny Maris OSS Edition の Web サイトは、 IIS へのホストを前提としています。

Contributing

AlesInfiny Maris OSS Edition への貢献については Contributing to AlesInfiny Maris OSS Edition を参照してください。

Code of Conduct

AlesInfiny Maris OSS Edition に関わるすべての人は、 AlesInfiny Maris OSS Edition の 行動規範 に従うことを期待しています。 これには、コードベース、課題追跡システム、チャットルーム、メーリングリストなど、すべてのコミュニケーションが含まれます。

License

BIPROGY 株式会社およびすべてのコントリビューターは、本リポジトリのドキュメントに クリエイティブ・コモンズ表示 4.0 国際ライセンス のライセンスを付与します。 詳細は LICENSE.md を参照してください。 また本リポジトリのソースコードに、 Apache License, Version 2.0 のライセンスを付与します。 詳細は LICENSE-CODE.md を参照してください。

このプロジェクトでは、様々なオープンソースライセンスの下でライセンスされている 3rd パーティーのライブラリを使用しています。 詳細は third-party-licenses フォルダーを参照してください。

このプロジェクトのライセンスは、 BIPROGY 株式会社の商標を使用する権利を付与するものではありません。 詳細は AlesInfiny Maris OSS Edition | 商標 を参照してください。