Merge pull request #13 from cliffbellman-dev/master

add 4 pull-requests: community standards, donate, deploy with ci/cd and website for docs, faq or tutorials

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ['https://github.com/integrativesoft/foton', 'https://integrative.io']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+THIS PROJECT IS IN MAINTENANCE MODE. We accept pull-requests for Bug Fixes **ONLY**. NO NEW FEATURES ACCEPTED!
+
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):

.github/workflows/static.yml

@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload entire repository
+          path: '.'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

CODE_OF_CONDUCT.md

@@ -0,0 +1,8 @@
+# Code of Conduct
+Foton is open for contribution from all people around the world. Whoever your are and whatever your background: nationality, gender, religion, we welcome you. Things to keep in mind:
+
+- Show empathy
+- Be patient
+- Accept constructive feedback
+
+If you have any questions, feel free to open an issue or reach out at [foton/issues](https://github.com/integrativesoft/foton/issues)

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Code of Conduct
+Foton is open for contribution from all people around the world. Whoever your are and whatever your background: nationality, gender, religion, we welcome you. Things to keep in mind:
+
+- Show empathy
+- Be patient
+- Accept constructive feedback
+
+If you have any questions, feel free to open an issue or reach out at [foton/issues](https://github.com/integrativesoft/foton/issues)

README.md

@@ -20,8 +20,8 @@
   <a href="https://opensource.org/licenses/Apache-2.0">
     <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Foton is licensed with Apache License 2.0">
   </a>
-  <a href="https://www.repostatus.org/#active">
-  <img src="https://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed."/>
+  <a href="https://www.repostatus.org/#experimental">
+  <img src="https://github.com/GIScience/badges/raw/master/status/experimental.svg" alt="Project Status: Experimental – The project has reached usable state and is being actively developed."/>
   </a>
 </div>
 
@@ -32,9 +32,6 @@
 ## About
 Foton is prototype for an Electron alternative written in C# by Integrative Software LLC and contributors.
 
-## Quick start
-First, download and install C# in Visual Studio - last version is required. 
-
 ## Features
 - Minimal size
 - Lightweight version of Electron

appveyor.yml

@@ -0,0 +1,43 @@
+version: AV_{build}
+image: Visual Studio 2019
+configuration: Release
+platform: Any CPU
+clone_depth: 1
+
+before_build:
+- cmd: >-
+    git submodule update --recursive --init
+
+    git clean -fdx
+
+    cd Source
+
+    nuget restore
+
+    cd ..
+    
+build:
+  project: Source\Foton.sln
+  verbosity: minimal
+
+after_build:
+- cmd: >-
+    DATA\PACKAGE_RELEASE.bat
+
+artifacts:
+  - path: Foton.zip
+    name: Foton.zip
+
+deploy:
+  tag: $(APPVEYOR_REPO_TAG_NAME)
+  release: 'Version $(APPVEYOR_REPO_TAG_NAME)'
+  description: '## Features\n\n - \n\n## Bugfixes\n\n - \n\n## Tasks\n\n - \n\n## Plugins\n\nPlugins included by default:\n~~~\nFilesystemPlugin   v\nHeadlessPlugin     v\nNextcloudPlugin    v\nSimpleNotePlugin   v\nStandardNotePlugin v\n~~~'
+  provider: GitHub
+  auth_token:
+    secure: add
+  artifact: Foton.zip
+  draft: true
+  prerelease: false
+  on:
+    branch: master
+    APPVEYOR_REPO_TAG: true

docs/README.md

@@ -0,0 +1,63 @@
+<!-- markdownlint-configure-file {
+  "MD013": {
+    "code_blocks": false,
+    "tables": false
+  },
+  "MD033": false,
+  "MD041": false
+} -->
+
+<div align="center">
+ <div align="center">
+      <img src="https://cdn-icons-png.flaticon.com/512/4214/4214992.png" width="100px" alt="logo"/>
+      <a> Foton </a>
+ </div>
+
+<br/>
+<div align="center">
+      <img src="https://img.shields.io/badge/c%23-%23239120.svg" alt="Csharp CI/CD">
+  </a>
+  <a href="https://opensource.org/licenses/Apache-2.0">
+    <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Foton is licensed with Apache License 2.0">
+  </a>
+  <a href="https://www.repostatus.org/#experimental">
+  <img src="https://github.com/GIScience/badges/raw/master/status/experimental.svg" alt="Project Status: Experimental – The project has reached usable state and is being actively developed."/>
+  </a>
+</div>
+
+</div>
+
+<br/>
+
+## About
+Foton is prototype for an Electron alternative written in C# by Integrative Software LLC and contributors.
+
+## Features
+- Minimal size
+- Lightweight version of Electron
+- Minimal resources
+
+## Contribute
+If you have any questions, feel free to open an issue.
+
+## Support
+- [x] Windows
+- [x] Linux
+
+## Roadmap
+- [ ] Add support for MacOS in future
+
+## Todo & test
+- [ ] Try to run the project in Windows and Linux and verify that it still works.
+- [ ] Update the version of C# and .NET to the latest version.
+- [ ] Verify that the 3rd party libraries for support in Windows and Linux still are maintained, update versions if needed.
+- [ ] Create a Hello World application that uses this library and runs cross-platform.
+
+## License
+- Foton is licensed with Apache License 2.0 by Integrative Software LLC and contributors
+- The [logo](https://www.flaticon.com/br/icone-gratis/foton_4214992) is licensed with Flaticon License: *free for personal and commercial use with attribution.*
+
+## Contributors
+<a href="https://github.com/integrativesoft/foton/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=integrativesoft/foton" width="90px"/>
+</a>

docs/_coverpage.md

@@ -0,0 +1 @@
+

docs/_navbar.md

@@ -0,0 +1 @@
+

docs/_sidebar.md

@@ -0,0 +1 @@
+

docs/index.html

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>foton</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="A vue wrapper for OrgChart.js">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
+  <link rel="icon" href="favicon.ico" type="image/x-icon"/>
+  <link rel="shortcut icon" href="favicon.ico" type="image/x-icon"/>
+  <link rel="icon" type="image/png" href="favicon.png"/>
+  <link rel="icon" type="image/png" href="/favicon.png"/>
+  <link rel="shortcut icon" type="image/ico" href="/favicon.ico"/>
+  <link rel="shortcut icon" type="image/ico" href="/favicon.ico"/>
+  <link rel="shortcut icon" type="image/png" href="/favicon.png"/>
+  <link rel="shortcut icon" type="image/png" href="/favicon.png"/>
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
+  <link rel="stylesheet" href="./src/css/style.css">
+  <link rel="stylesheet" href="./src/css/style.min.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/babel-standalone"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify-demo-box-vue/dist/docsify-demo-box-vue.min.js"></script>
+  <script src="./src/js/index.min.js"></script>
+  <script>
+    var bootCode = ''
+    var jsResources = '<scr' + 'ipt src="https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"></scr' + 'ipt>'
+                      + '\n<scr' + 'ipt src="https://cdn.jsdelivr.net/npm/vue-orgchart/dist/vue-orgchart.min.js"></scr' + 'ipt>'
+    var cssResources = '@import url("https://cdn.jsdelivr.net/npm/vue-orgchart/dist/style.min.css");'
+    window.$docsify = {
+      toc: {
+         tocMaxLevel: 14,
+         target: 'h2, h3, h4, h5, h6'
+      },
+      alias: {
+        '/.*/_sidebar.md': '/_sidebar.md',
+      },
+      subMaxLevel: 3,
+      sidebarDisplayLevel: 1, // set sidebar display level
+      coverpage: true,
+      loadSidebar: true,
+      loadNavbar: true,
+      repo: 'https://github.com/integrativesoft/foton',
+      plugins: [
+        DemoBoxVue.create(jsResources, cssResources)
+      ]
+    }
+  </script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/html2canvas.min.js"></script>
+  <!-- <script src="https://unpkg.com/[email protected]/dist/docsify-plugin-toc.min.js"></script> --->
+  <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js"></script>
+</body>
+</html>