Add docs

Author: CodeDoctorDE

CODE_OF_CONDUCT.md

@@ -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
+[email protected].
+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.

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Contribution guide
+
+There are many ways to contribute to this project.
+Thanks to everyone who has contributed!
+If you have any questions, please contact me at <[email protected]>.
+
+There is a matrix server for this project [here](https://linwood.dev/matrix) and a discord server [here](https://discord.linwood.dev).
+
+Please follow the [Code of Conduct](https://docs.qeck.linwood.dev/code-of-conduct).
+
+## Give feedback
+
+The best way to give feedback is to open an issue on GitHub.
+Please report any bug you find [here](https://github.com/LinwoodDev/Qeck/issues/new?assignees=CodeDoctorDE&labels=bug%2Ctriage&template=bug_report.yml&title=%5BBug%5D%3A+).
+
+If you have a feature that you would like to see added, please open an issue [here](https://github.com/LinwoodDev/Qeck/issues/new?assignees=CodeDoctorDE&labels=enhancement%2Ctriage&template=feature_request.yml&title=%5BFeature+request%5D%3A+).
+
+## Test nightly builds
+
+Nightly builds are not production ready and need to be tested.
+Please report any bugs in the github issues section.
+
+Read more about it [here](https://docs.qeck.linwood.dev/nightly).
+
+## Write documentation
+
+Documentation is important for users to understand the program and its features.
+The documentation is written in markdown, a simple markup language. It can be found in the `docs` folder.
+
+To start, please install yarn (<https://yarnpkg.com/getting-started/install>).
+
+Get started by running:
+
+```bash
+cd docs
+yarn install
+yarn start
+```
+
+All stable documentation can be found in the `versioned_docs` folder.
+
+Fork the project and create a pull request to add your documentation to the `develop` branch.
+
+## Translate
+
+Crowdin is a service that allows you to translate the documentation and the app.
+Click [here](https://translate.linwood.dev/qeck) to see the project and start translating.
+If you have a new language to add, please contact me.
+
+## Code
+
+This project is written in [Dart](https://dart.dev/) and was built with [Flutter](https://flutter.dev/).
+The app source code can be found in the `app` folder.
+
+Please install the dependencies first:
+
+- libsecret-1-dev
+- libjsoncpp-dev
+
+To get started, run:
+
+```bash
+cd app
+flutter pub get
+flutter run
+```
+
+All subdirectories are documented in the `app/README.md` file.
+
+Fork the project and create a pull request to add your code to the `develop` branch.

README.md

@@ -1,6 +1,5 @@
 # Linwood Qeck
 
-[![Powered by Flame](https://img.shields.io/badge/Powered%20by-%F0%9F%94%A5%20Flame-orange.svg?style=for-the-badge)](https://flame-engine.org)
 [![GitHub](https://img.shields.io/github/license/LinwoodCloud/Qeck?style=for-the-badge&color=orange)](LICENSE)
 
 *Please note that this project is in development!*

app/pubspec.lock

@@ -225,14 +225,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.1.0"
-  flame:
-    dependency: "direct main"
-    description:
-      name: flame
-      sha256: c38e1be5827aa839c166c6ed08a2733bb4523bf153d8c670739c20c842fa1844
-      url: "https://pub.dev"
-    source: hosted
-    version: "1.7.3"
   flex_color_scheme:
     dependency: "direct main"
     description:
@@ -470,14 +462,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.0"
-  ordered_set:
-    dependency: transitive
-    description:
-      name: ordered_set
-      sha256: "3fedcc9121b3ba24c0a84f32da2989c42e36c159b73feadbc2f402dc55966b81"
-      url: "https://pub.dev"
-    source: hosted
-    version: "5.0.1"
   package_config:
     dependency: transitive
     description:
@@ -514,10 +498,10 @@ packages:
     dependency: "direct main"
     description:
       name: path_provider
-      sha256: c7edf82217d4b2952b2129a61d3ad60f1075b9299e629e149a8d2e39c2e6aad4
+      sha256: "3087813781ab814e4157b172f1a11c46be20179fcc9bea043e0fba36bc0acaa2"
       url: "https://pub.dev"
     source: hosted
-    version: "2.0.14"
+    version: "2.0.15"
   path_provider_android:
     dependency: transitive
     description:
@@ -530,10 +514,10 @@ packages:
     dependency: transitive
     description:
       name: path_provider_foundation
-      sha256: ad4c4d011830462633f03eb34445a45345673dfd4faf1ab0b4735fbd93b19183
+      sha256: "1995d88ec2948dac43edf8fe58eb434d35d22a2940ecee1a9fefcd62beee6eb3"
       url: "https://pub.dev"
     source: hosted
-    version: "2.2.2"
+    version: "2.2.3"
   path_provider_linux:
     dependency: transitive
     description:
@@ -651,10 +635,10 @@ packages:
     dependency: "direct main"
     description:
       name: shared_preferences
-      sha256: "858aaa72d8f61637d64e776aca82e1c67e6d9ee07979123c5d17115031c1b13b"
+      sha256: "16d3fb6b3692ad244a695c0183fca18cf81fd4b821664394a781de42386bf022"
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.0"
+    version: "2.1.1"
   shared_preferences_android:
     dependency: transitive
     description:
@@ -667,10 +651,10 @@ packages:
     dependency: transitive
     description:
       name: shared_preferences_foundation
-      sha256: "0c1c16c56c9708aa9c361541a6f0e5cc6fc12a3232d866a687a7b7db30032b07"
+      sha256: e014107bb79d6d3297196f4f2d0db54b5d1f85b8ea8ff63b8e8b391a02700feb
       url: "https://pub.dev"
     source: hosted
-    version: "2.2.1"
+    version: "2.2.2"
   shared_preferences_linux:
     dependency: transitive
     description:

app/pubspec.yaml

@@ -27,7 +27,7 @@ dependencies:
   intl: ^0.17.0
   flutter_localized_locales: ^2.0.4
   # Engine
-  flame: ^1.7.3
+  #flame: ^1.7.3
   # UI
   phosphor_flutter:
     git:
@@ -41,7 +41,7 @@ dependencies:
   flex_color_scheme: ^7.0.5
   window_manager: ^0.3.2
   # Database
-  shared_preferences: ^2.1.0
+  shared_preferences: ^2.1.1
   # Generation
   barcode: ^2.2.3
   # Internal
@@ -51,7 +51,7 @@ dependencies:
   # Information
   http: ^0.13.6
   package_info_plus: ^3.1.2
-  path_provider: ^2.0.14
+  path_provider: ^2.0.15
   go_router: ^7.0.0
   json_annotation: ^4.8.1
   dynamic_color: ^1.6.3

docs/community/branding.md

@@ -0,0 +1,17 @@
+---
+title: Branding
+---
+
+These assets are licensed under the [CC-BY-4.0](https://github.com/LinwoodDev/Qeck/blob/develop/BRANDING_LICENSE).
+
+## Fonts
+
+* `Roboto`
+
+## Screenshots
+
+> Used in the firefox responsive design mode
+
+* Phone: Galaxy S20 Ultra
+* 7-inch tablet: Nexus 7
+* 10-inch tablet: Nexus 10

docs/community/changelog.md

@@ -0,0 +1,13 @@
+---
+title: Changelog
+hide_title: true
+sidebar_label: Changelog
+---
+
+```mdx-code-block
+import Changelog, {toc as ChangelogTOC} from "@site/../CHANGELOG.md"
+
+<Changelog />
+
+export const toc = ChangelogTOC;
+```

docs/community/code-of-conduct.md

@@ -0,0 +1,13 @@
+---
+title: Code of conduct
+hide_title: true
+sidebar_label: Code of conduct
+---
+
+```mdx-code-block
+import CodeOfConduct, {toc as CodeOfConductTOC} from "@site/../CODE_OF_CONDUCT.md"
+
+<CodeOfConduct />
+
+export const toc = CodeOfConductTOC;
+```

docs/community/contributing.md

@@ -0,0 +1,13 @@
+---
+title: "Contributing"
+hide_title: true
+sidebar_label: "Contributing"
+---
+
+```mdx-code-block
+import Contributing, {toc as ContributingTOC} from "@site/../CONTRIBUTING.md"
+
+<Contributing />
+
+export const toc = ContributingTOC;
+```

docs/community/downloads/_category_.json

@@ -0,0 +1,3 @@
+{
+  "label": "Downloads"
+}