upload

Author: webdevstar

docs/README.md

@@ -0,0 +1,46 @@
+# Documentation
+
+### General
+* Getting Started
+  - [with GitHub](./getting-started.md)
+  - [with Docker](./getting-started-docker.md)
+* [How to deploy a Cezerin on Ubuntu 16.04 (from Docker)](./how-to-deploy-a-cezerin-on-ubuntu-16-04.md)
+* [How to deploy a Cezerin on Ubuntu 18.04.1 (from GitHub)](./how-to-deploy-a-cezerin-on-ubuntu-18-04-1-github.md)
+* [Application Structure](./structure.md)
+* [Initialize MongoDB](./initialize-mongodb.md)
+* [API Reference](./api)
+* [API Client](https://github.com/cezerin/client)
+* Theme customization
+* Localization
+* Payment Gateway
+* Web Service
+
+### Questions
+
+* How to change language
+
+### Recipes
+
+* How to Integrate Disqus
+<!-- * [How to Integrate Disqus](./recipes/how-to-integrate-disqus.md) -->
+
+### NPM Scripts
+
+|`npm run <script>`|Description|
+|------------------|-----------|
+|`clean:admin`|Delete admin asset bundles.|
+|`clean:store`|Delete store asset bundles.|
+|`compile:dev`|Compiles the application to disk **and watch** (`~/dist` by default).|
+|`compile`|Compiles the application to disk (`~/dist` by default).|
+|`webpack:admin:dev`|Assemble admin bundles **and watch**.|
+|`webpack:store:dev`|Assemble store bundles **and watch**.|
+|`webpack:admin:prod`|Assemble admin bundles.|
+|`webpack:store:prod`|Assemble store bundles.|
+|`theme:install`|Install theme from /public/<file>.zip|
+|`theme:export`|Zip current theme to /public/<file>.zip|
+|`theme:copy`|Compile theme and copy assets to /public/|
+|`theme:build:dev`|Refresh theme after modification **and watch**.|
+|`theme:build:prod`|Refresh theme after modification.|
+|`build:dev`|Compile and assemble bundles **and watch**.|
+|`build`|Compile and assemble bundles.|
+|`start`|Start node server.|

docs/api/README.md

@@ -0,0 +1,32 @@
+# API Reference
+
+* [Apps](./apps.md)
+* [Products](./products.md)
+* [Product Categories](./product-categories.md)
+* Orders
+* Order Statuses
+* Customers
+* Customer Groups
+* Pages
+* Shipping Methods
+* Payment Methods
+* Payment Gateways
+* Payment Notifications
+* Files
+* Security
+* Settings
+* Site Map
+* Theme
+* Redirects
+* [Webhooks](./webhooks.md)
+
+## Overview
+
+### Authentication
+Authenticate your account when using the API by including your Access Token in the request. You can manage your Access Tokens in the Dashboard. Your Access Tokens carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.
+
+Authentication to the API is performed via bearer auth (e.g., for a cross-origin request), use
+
+```
+-H "Authorization: Bearer <token>"
+```

docs/api/apps.md

@@ -0,0 +1,38 @@
+# Apps
+
+Client-side apps on the dashboard.
+
+* [Retrieve settings](#retrieve-settings)
+* [Update settings](#update-settings)
+
+## Retrieve settings
+
+```
+GET /api/v1/apps/{app_key}/settings
+```
+
+#### Response body
+
+```js
+{
+  "_id": "5a2fafb31aaff82bc574b4ad",
+  "key": "{app_key}",
+  "property-1": "String data",
+  "property-2": "String data"
+}
+```
+
+## Update settings
+
+```
+PUT /api/v1/apps/{app_key}/settings
+```
+
+#### Request body
+
+```js
+{
+  "property-1": "String data",
+  "property-2": "String data"
+}
+```

docs/api/product-categories.md

@@ -0,0 +1,86 @@
+# Product Categories
+
+* [List all categories](#list-all-categories)
+* [Retrieve a category](#retrieve-a-category)
+* [Create a category](#create-a-category)
+* [Update a category](#update-a-category)
+* [Delete a category](#delete-a-category)
+* [Upload a category image](#upload-a-category-image)
+* [Delete a category image](#delete-a-category-image)
+
+## List all categories
+
+```
+GET /api/v1/product_categories
+```
+
+#### Query parameters
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `fields` | `string` | Comma-separated list of fields. Example `id,parent_id,name`  |
+| `enabled` | `boolean` | Only enabled categories |
+
+## Retrieve a category
+
+```
+GET /api/v1/product_categories/{category_id}
+```
+
+## Create a category
+
+```
+POST /api/v1/product_categories
+```
+
+#### Request body
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `name` | `string` | - |
+| `description` | `string` | - |
+| `meta_description` | `string` | - |
+| `meta_title` | `string` | - |
+| `enabled` | `boolean` | - |
+| `sort` | `string` | - |
+| `parent_id` | `string` | - |
+| `position` | `integer` | - |
+| `slug` | `string` | - |
+
+## Update a category
+
+```
+PUT /api/v1/product_categories/{category_id}
+```
+
+#### Request body
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `name` | `string` | - |
+| `description` | `string` | - |
+| `meta_description` | `string` | - |
+| `meta_title` | `string` | - |
+| `enabled` | `boolean` | - |
+| `sort` | `string` | - |
+| `parent_id` | `string` | - |
+| `position` | `integer` | - |
+| `slug` | `string` | - |
+
+## Delete a category
+
+```
+DELETE /api/v1/product_categories/{category_id}
+```
+
+## Upload a category image
+
+```
+POST /api/v1/product_categories/{category_id}/image
+```
+
+## Delete a category image
+
+```
+DELETE /api/v1/product_categories/{category_id}/image
+```