aureus user-guide created

.gitignore

@@ -0,0 +1,18 @@
+# Vscode
+.vscode
+
+# Vitepress
+.vitepress/dist
+.vitepress/cache
+.vitepress/.temp
+
+# Node.js
+node_modules/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*

.prettierignore

@@ -0,0 +1 @@
+*.vue

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "printWidth": 75
+}

.vitepress/config.ts

@@ -0,0 +1,116 @@
+import { defineConfig } from 'vitepress'
+import sidebar from './routes'
+
+
+
+export default defineConfig({
+  vite: {
+    server: {
+      host: true,
+      port: 5173,
+      allowedHosts: true // your ngrok domain
+    }
+  },
+  lang: 'en-US',
+  srcDir: 'src',
+  title: 'Aureus ERP',
+  base: '/',
+  description: 'The powerful Open Source ERP platform built on Laravel',
+  head: [
+    ['link', { rel: 'icon', href: '/favicon.ico' }],
+    ['meta', { name: 'theme-color', content: '#3eaf7c' }],
+    ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
+    [
+      'meta',
+      { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }
+    ],
+    [
+      'meta',
+      {
+        name: 'description',
+        content:
+          'An Open-Source Laravel Enterprise Resource Planning (ERP) platform designed for Small and Medium Enterprises (SMEs) as well as large-scale enterprises.'
+      }
+    ],
+    ['link', { rel: 'canonical', href: 'https://aureuserp.com/' }],
+
+    ['meta', { property: 'og:locale', content: 'en-US' }],
+    ['meta', { property: 'og:type', content: 'website' }],
+    [
+      'meta',
+      {
+        property: 'og:title',
+        content: 'Aureus ERP - Open Source ERP Platform'
+      }
+    ],
+    [
+      'meta',
+      {
+        property: 'og:description',
+        content:
+          'An Open-Source Laravel Enterprise Resource Planning (ERP) platform designed for Small and Medium Enterprises (SMEs) as well as large-scale enterprises.'
+      }
+    ],
+    [
+      'meta',
+      { property: 'og:url', content: 'https://devdocs.aureuserp.com/' }
+    ],
+    [
+      'meta',
+      {
+        property: 'og:site_name',
+        content: 'Aureus ERP - Open Source ERP Platform'
+      }
+    ]
+  ],
+
+  themeConfig: {
+    logo: {
+      light: '/images/logo-dark.svg',
+      dark: '/images/logo-light.svg'
+    },
+
+    siteTitle: false,
+
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Contribute To Aureus ERP', link: 'https://github.com/aureuserp/aureuserp' },
+      {
+        text: 'Dev Docs',
+        link: 'https://devdocs.aureuserp.com/'
+      },
+      { text: 'Contact Us', link: 'https://aureuserp.com/en/contacts/' },
+      { component: 'VersionSwitcher' }
+    ],
+
+    sidebar,
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/aureuserp/aureuserp' }
+    ],
+
+    editLink: {
+      pattern:
+        'https://github.com/aureuserp/dev-docs/blob/master/src/:path',
+      text: 'Edit this page on GitHub'
+    },
+
+    footer: {
+      message:
+        'Released under the <a href="https://opensource.org/licenses/mit" target="_blank" class="mit-license">MIT License</a>.',
+      copyright: `Copyright © ${new Date().getFullYear()} Webkul`
+    },
+
+    lastUpdated: {
+      text: 'Last updated',
+      formatOptions: {
+        dateStyle: 'full'
+      }
+    },
+
+    search: {
+      provider: 'local'
+    }
+  }
+})
+

.vitepress/routes/index.ts

@@ -0,0 +1,5 @@
+import master from './master'
+
+export default {
+  '/master/': master
+}

.vitepress/routes/master.ts

@@ -0,0 +1,163 @@
+const routes = [
+  {
+    text: 'Invoices',
+    collapsed: false,
+    items: [
+      {
+        text: 'Customers',
+        collapsed: true,
+        items: [
+          { text: 'Products', link: '/master/invoice/customers/products' },
+          { text: 'Customers', link: '/master/invoice/customers/customers' },
+          { text: 'Invoices', link: '/master/invoice/customers/invoices' },
+          { text: 'Credit Notes', link: '/master/invoice/customers/credit-notes' },
+          { text: 'Payments', link: '/master/invoice/customers/payments' },
+        ]
+      },
+      {
+        text: 'Vendors',
+        collapsed: true,
+        items: [
+          { text: 'Products', link: '/master/invoice/vendors/products' },
+          { text: 'Vendors', link: '/master/invoice/vendors/vendors' },
+          { text: 'Bills', link: '/master/invoice/vendors/bills' },
+          { text: 'Refunds', link: '/master/invoice/vendors/refunds' },
+          { text: 'Payments', link: '/master/invoice/vendors/payments' },
+        ]
+      },
+      { text: 'Configurations', link: '/master/invoice/configurations' },
+      { text: 'Settings', link: '/master/invoice/settings' },
+    ]
+  },
+  {
+    text: 'Sales',
+    collapsed: false,
+    items: [
+      {
+        text: 'Orders',
+        collapsed: true,
+        items: [
+          { text: 'Quotations', link: '/master/sales/orders/quotations' },
+          { text: 'Orders', link: '/master/sales/orders/orders' },
+          { text: 'Customers', link: '/master/sales/orders/customers' },
+        ]
+      },
+      { text: 'To Invoice', link: '/master/sales/toInvoice' },
+      { text: 'Products', link: '/master/sales/products' },
+      { text: 'Configurations', link: '/master/sales/configurations' },
+      { text: 'Settings', link: '/master/sales/settings' },
+    ]
+  },
+  {
+    text: 'Purchase',
+    collapsed: false,
+    items: [
+      {
+        text: 'Orders',
+        collapsed: true,
+        items: [
+          { text: 'Quotations', link: '/master/purchase/orders/quotations' },
+          { text: 'Purchase Orders', link: '/master/purchase/orders/purchase-orders' },
+          { text: 'Purchase Agreements', link: '/master/purchase/orders/purchase-agreements' },
+          { text: 'Vendors', link: '/master/purchase/orders/vendors' },
+        ]
+      },
+      { text: 'Products', link: '/master/purchase/products' },
+      { text: 'Configurations', link: '/master/purchase/configurations' },
+      { text: 'Settings', link: '/master/purchase/settings' },
+    ]
+  },
+  {
+    text: 'Inventory',
+    collapsed: false,
+    items: [
+      {
+        text: 'Operations',
+        collapsed: true,
+        items: [
+          { text: 'Transfers', link: '/master/inventory/operations/transfers' },
+          { text: 'Adjustments', link: '/master/inventory/operations/adjustments' },
+        ]
+      },
+      {
+        text: 'Products',
+        collapsed: true,
+        items: [
+          { text: 'Products', link: '/master/inventory/products/products' },
+          { text: 'Packages', link: '/master/inventory/products/packages' },
+          { text: 'Lots/Serial Number', link: '/master/inventory/products/lots-serial-number' },
+        ]
+      },
+      {
+        text: 'Configurations',
+        collapsed: true,
+        items: [
+          { text: 'Warehouse Management', link: '/master/inventory/configurations/warehouse-management' },
+          { text: 'Products', link: '/master/inventory/configurations/products' },
+          { text: 'Delivery', link: '/master/inventory/configurations/delivery' },
+        ]
+      },
+      { text: 'Settings', link: '/master/inventory/settings' },
+    ]
+  },
+  {
+    text: 'Contacts',
+    collapsed: false,
+    items: [
+      { text: 'Contacts', link: '/master/contact/contacts' },
+      { text: 'Configurations', link: '/master/contact/configurations' },
+    ]
+  },
+  {
+    text: 'Project',
+    collapsed: false,
+    items: [
+      { text: 'Projects', link: '/master/project/projects' },
+      { text: 'Tasks', link: '/master/project/tasks' },
+      { text: 'Configurations', link: '/master/project/configurations' },
+      { text: 'Settings', link: '/master/project/settings' }
+    ]
+  },
+  {
+    text: 'Website',
+    collapsed: false,
+    items: [
+      { text: 'Blog Posts', link: '/master/website/blog-posts' },
+      { text: 'Pages', link: '/master/website/pages' },
+      { text: 'Customers', link: '/master/website/customers' },
+      { text: 'Configuartions', link: '/master/website/configurations' },
+      { text: 'Settings', link: '/master/website/settings' },
+    ]
+  },
+  {
+    text: 'Employees',
+    collapsed: false,
+    items: [
+      { text: 'Employees', link: '/master/employees/employees' },
+      { text: 'Departments', link: '/master/employees/departments' },
+      { text: 'Reportings', link: '/master/employees/reportings' },
+      { text: 'Configurations', link: '/master/employees/configurations' },
+    ]
+  },
+  {
+    text: 'Recruitments',
+    collapsed: false,
+    items: [
+      { text: 'Applications', link: '/master/recruitment/applications' },
+      { text: 'Configurations', link: '/master/recruitment/configuration' },
+    ]
+  },
+  {
+    text: 'Time Off',
+    collapsed: false,
+    items: [
+      { text: 'My Time', link: '/master/timeOff/my-time' },
+      { text: 'Overview', link: '/master/timeOff/overview' },
+      { text: 'Management', link: '/master/timeOff/management' },
+      { text: 'Reporting', link: '/master/timeOff/reporting' },
+      { text: 'Configuration', link: '/master/timeOff/configuration' },
+    ]
+  },
+]
+
+export default routes