Merge branch 'main' of https://github.com/horde-lord/horde

README.md

@@ -1,4 +1,69 @@
-![CI](https://github.com/horde-lord/horde/actions/workflows/dotnet.yml/badge.svg)
+
 
 # horde
-Gamify your app with horde
+
+![Logo](https://drive.google.com/file/d/17EaqXOfYmqBJwoWWuwEuCwv0_HEnWLfn/view?usp=sharing.jpeg)
+
+![CI](https://github.com/horde-lord/horde/actions/workflows/dotnet.yml/badge.svg)
+
+[![License](https://img.shields.io/badge/License-GPL_v3-blue
+)](LICENSE)
+
+
+## Table of Contents <!-- omit from toc -->
+>
+- [horde](#horde)
+  - [About](#about)
+  - [Features](#features)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+      - [Using libraries from nuget](#using-libraries-from-nuget)
+      - [Using Horde UI](#using-horde-ui)
+      - [Using APIs](#using-apis)
+  - [Usage](#usage)
+- [Example command](#example-command)
+
+
+
+## About
+
+Horde is a open source solution for gamification with multiple features.
+
+## Features
+- Gamification
+- Digital currency management
+- Community management
+- E-commerce management
+
+
+![Features](https://linktoimage/)
+
+## Getting Started
+
+### Prerequisites
+
+List the software and tools required before installing your project.
+
+- Tool 1
+- Tool 2
+
+### Installation
+
+Using librabries from nuget is crrently the only method to set up horde while APIs and a webapp is planned for the near future.
+
+
+#### Using libraries from nuget
+
+
+#### Using Horde UI
+
+#### Using APIs
+
+## Usage
+
+Sample code blocks
+
+```sh
+# Example command
+example_command

introduction.mdx

@@ -0,0 +1,71 @@
+---
+title: Introduction
+description: 'Welcome to Tribal Arena Gamification'
+---
+
+<img
+  className="block dark:hidden"
+  src="/images/hero-light.svg"
+  alt="Hero Light"
+/>
+<img
+  className="hidden dark:block"
+  src="/images/hero-dark.svg"
+  alt="Hero Dark"
+/>
+
+## Setting up
+
+Lets help you get power of Tribal Gamification in your app in just a few lines of code
+
+<CardGroup cols={2}>
+  <Card
+    title="Edit Your Docs"
+    icon="pen-to-square"
+    href="https://mintlify.com/docs/quickstart"
+  >
+    Get your docs set up locally for easy development
+  </Card>
+  <Card
+    title="Preview Changes"
+    icon="image"
+    href="https://mintlify.com/docs/development"
+  >
+    Preview your changes before you push to make sure they're perfect
+  </Card>
+</CardGroup>
+
+## Make it yours
+
+Update your docs to your brand and add valuable content for the best user conversion.
+
+<CardGroup cols={2}>
+  <Card
+    title="Customize Style"
+    icon="palette"
+    href="https://mintlify.com/docs/settings/global"
+  >
+    Customize your docs to your company's colors and brands
+  </Card>
+  <Card
+    title="Reference APIs"
+    icon="code"
+    href="https://mintlify.com/docs/api-playground/openapi"
+  >
+    Automatically generate endpoints from an OpenAPI spec
+  </Card>
+  <Card
+    title="Add Components"
+    icon="screwdriver-wrench"
+    href="https://mintlify.com/docs/components/accordion"
+  >
+    Build interactive features and designs to guide your users
+  </Card>
+  <Card
+    title="Get Inspiration"
+    icon="stars"
+    href="https://mintlify.com/customers"
+  >
+    Check out our showcase of our favorite documentation
+  </Card>
+</CardGroup>

mint.json

@@ -0,0 +1,91 @@
+{
+    "$schema": "https://mintlify.com/schema.json",
+    "name": "Starter Kit",
+    "logo": {
+      "dark": "/logo/dark.svg",
+      "light": "/logo/light.svg"
+    },
+    "favicon": "/favicon.svg",
+    "colors": {
+      "primary": "#0D9373",
+      "light": "#07C983",
+      "dark": "#0D9373",
+      "anchors": {
+        "from": "#0D9373",
+        "to": "#07C983"
+      }
+    },
+    "topbarLinks": [
+      {
+        "name": "Support",
+        "url": "mailto:[email protected]"
+      }
+    ],
+    "topbarCtaButton": {
+      "name": "Dashboard",
+      "url": "https://dashboard.mintlify.com"
+    },
+    "tabs": [
+      {
+        "name": "API Reference",
+        "url": "api-reference"
+      }
+    ],
+    "anchors": [
+      {
+        "name": "Documentation",
+        "icon": "book-open-cover",
+        "url": "https://mintlify.com/docs"
+      },
+      {
+        "name": "Community",
+        "icon": "slack",
+        "url": "https://mintlify.com/community"
+      },
+      {
+        "name": "Blog",
+        "icon": "newspaper",
+        "url": "https://mintlify.com/blog"
+      }
+    ],
+    "navigation": [
+      {
+        "group": "Get Started",
+        "pages": [
+          "introduction",
+          "quickstart",
+          "development"
+        ]
+      },
+      {
+        "group": "Essentials",
+        "pages": [
+          "essentials/markdown",
+          "essentials/code",
+          "essentials/images",
+          "essentials/settings",
+          "essentials/navigation",
+          "essentials/reusable-snippets"
+        ]
+      },
+      {
+        "group": "API Documentation",
+        "pages": [
+          "api-reference/introduction"
+        ]
+      },
+      {
+        "group": "Endpoint Examples",
+        "pages": [
+          "api-reference/endpoint/get",
+          "api-reference/endpoint/create",
+          "api-reference/endpoint/delete"
+        ]
+      }
+    ],
+    "footerSocials": {
+      "x": "https://x.com/mintlify",
+      "github": "https://github.com/mintlify",
+      "linkedin": "https://www.linkedin.com/company/mintsearch"
+    }
+  }

quickstart.mdx

@@ -0,0 +1,86 @@
+---
+title: 'Quickstart'
+description: 'Start building awesome documentation in under 5 minutes'
+---
+
+## Setup your development
+
+Learn how to update your docs locally and and deploy them to the public.
+
+### Edit and preview
+
+<AccordionGroup>
+  <Accordion icon="github" title="Clone your docs locally">
+    During the onboarding process, we created a repository on your Github with
+    your docs content. You can find this repository on our
+    [dashboard](https://dashboard.mintlify.com). To clone the repository
+    locally, follow these
+    [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
+    in your terminal.
+  </Accordion>
+  <Accordion icon="rectangle-terminal" title="Preview changes">
+    Previewing helps you make sure your changes look as intended. We built a
+    command line interface to render these changes locally. 1. Install the
+    [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
+    documentation changes locally with this command:  npm i -g mintlify 
+    2. Run the following command at the root of your documentation (where
+    mint.json is):  mintlify dev 
+  </Accordion>
+</AccordionGroup>
+
+### Deploy your changes
+
+<AccordionGroup>
+
+<Accordion icon="message-bot" title="Install our Github app">
+  Our Github app automatically deploys your changes to your docs site, so you
+  don't need to manage deployments yourself. You can find the link to install on
+  your [dashboard](https://dashboard.mintlify.com). Once the bot has been
+  successfully installed, there should be a check mark next to the commit hash
+  of the repo.
+</Accordion>
+<Accordion icon="rocket" title="Push your changes">
+  [Commit and push your changes to
+  Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
+  for your changes to update in your docs site. If you push and don't see that
+  the Github app successfully deployed your changes, you can also manually
+  update your docs through our [dashboard](https://dashboard.mintlify.com).
+</Accordion>
+
+</AccordionGroup>
+
+## Update your docs
+
+Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
+
+<CardGroup>
+
+<Card title="Style Your Docs" icon="paintbrush" href="/settings/global">
+  Add flair to your docs with personalized branding.
+</Card>
+
+<Card
+  title="Add API Endpoints"
+  icon="square-code"
+  href="/api-playground/configuration"
+>
+  Implement your OpenAPI spec and enable API user interaction.
+</Card>
+
+<Card
+  title="Integrate Analytics"
+  icon="chart-mixed"
+  href="/analytics/supported-integrations"
+>
+  Draw insights from user interactions with your documentation.
+</Card>
+
+<Card
+  title="Host on a Custom Domain"
+  icon="browser"
+  href="/settings/custom-domain/subdomain"
+>
+  Keep your docs on your own website's subdomain.
+</Card>
+
+</CardGroup>