Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing Transactables #373

Merged
merged 1 commit into from
Feb 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,6 @@ Each policy is parsed using Liquid, and the system checks them in order of their

[Learn more about Authorization Policies in our Get Started guides](/tutorials/authorization-policy/authorization-policy)

## Transactables, Transactable Types

**Transactable** represents a resource around which any transaction is made. Transactables can be products (e.g. users selling products that other users want to buy), services (e.g. matching users who provide services with those who want to hire them), or projects (e.g. matching users with a project to experts who can accomplish it).

**Transactable Types** allow you to define Transactables in terms of what Properties, images, addresses and attachments they have per business rules.

[Learn how to use Transactables and Transactable Types in our Get Started guides](/tutorials/transactables/transactables)

## Translations

You can use platformOS to build sites in any language, and each site can have multiple language versions. **Translations** are yml files used for multilingual sites but also used to define date formats, flash messages or system-wide default error messages like "can't be blank".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,23 +272,6 @@ A special case of deploy is a deploy with a `--force` (or `-f`) flag. It means i

Syncing to any environment means that marketplace-kit is watching your filesystem for changes. Whenever you change a file, it automatically picks it up and sends it to the server. If this operation fails, you will see a message in your console – we have some validations on the server side to prevent you from deploying corrupted code and breaking your marketplace.

## Transactable

Transactable is the core concept in our platform, it represents a resource around which any transaction is made. This model should be used to represent for example:

* Product: If you want to build a marketplace matching people who want to sell or rent something with the ones who want to borrow or buy it, then the product is a Transactable.
* Service: If you want to build a marketplace matching people who provide services with those who want to hire them, the services are Transactables. Technically speaking, the system does not really allow to hire people per se (Users or UserProfiles) – you’ll always need a Transactable object, even if it's invisible from the UI level.
* Project: If you want to build a marketplace for users with a particular idea or task, who would like to get offers from experts, and then choose one expert, then they have to describe the task/job/project they want to have completed. This task/job/project is a Transactable.

Learn more:

* [Transactables](/tutorials/transactables/transactables)


## Transactables, Transactable Type

Transactable Types allow you to define Transactables in terms of what Properties, images, addresses and attachments they have per business rules.

## Translations

Translations are yml files used for multilingual sites but also used to define date format, or flash messages.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
converter: markdown
metadata:
title: Codebase
description:
description:
slug: how-platformos-works/platformos-workflow/codebase
searchable: true
---

You develop your site (write code) in your **codebase** in your local environment.
You develop your site (write code) in your **codebase** in your local environment.

## Required directory structure
## Required directory structure

In order to correctly communicate with the platformOS engine and API, your codebase should be organized into a specific directory structure. The root directory of your project should contain the marketplace_builder directory.
In order to correctly communicate with the platformOS engine and API, your codebase should be organized into a specific directory structure. The root directory of your project should contain the marketplace_builder directory.

### Recommended directories and files inside the `marketplace_builder` and `modules/<module name>` directories

Expand All @@ -27,10 +27,8 @@ In order to correctly communicate with the platformOS engine and API, your codeb
| views/pages | Directory for files that define pages. | [Pages](/tutorials/pages/pages) |
| views/layouts | Directory for layouts | [Layout](/tutorials/pages/layouts) |
| views/partials | Directory for partials &ndash; reusable snippets of Liquid code usually used to render HTML. | |
| transactable_types | Directory for files that define Transactable Types. | [Transactables](/tutorials/transactables/transactables) |
| translations | Directory for yml files of Translations for multilingual sites, also used to define date format, or flash messages. | [Translations](/tutorials/translations/translations) |
| user_profile_types | Directory for yml files that define User Profiles. Each instance includes one user role, called ‘default’, so each instance needs to include the default.yml file inside this directory. | [Users](/tutorials/users/users) |



{% include 'shared/questions_section' %}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ searchable: true

**Custom Model Type is an object that describes all Customization objects that belong to it.**

You can think of it as a DB table, whereas Customizations are records inside this table - hence Customization must always be associated with exactly one CustomModelType.
You can think of it as a DB table, whereas Customizations are records inside this table - hence Customization must always be associated with exactly one CustomModelType.

Example:
Custom Model Types define object types that will exist in your application. They describe the properties each object can have. For example, if you want your application to manage "books", you can create a Custom Model Type with the name "book" that will have the properties "title" and "author" (both having the type "string"). Individual books in your application will be "customization" objects tied to this custom model type, and you will be able to set actual values for the "title" and "author" of each book.
Expand Down Expand Up @@ -55,7 +55,6 @@ properties:
| properties | Array of properties you want to contain within your models. Equivalent to a column in a database table. | No |
| instance_profile_types | | No |
| relationship_types | | No |
| transactable_types | | No |

# Form Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ This is a collection of Form Configuration examples from other topics in our doc
* [Building a Contact Form with Customization](/tutorials/customizations/building-contact-form-with-customization#step-2-define-contact-form-–-form-object)
* [Creating Product Management Forms](/use-cases/e-commerce/creating-product-management-forms)
* [Session Form](/use-cases/e-commerce/using-shared-partials#step-5-update-existing-forms)
* [Remove Transactable Form](/tutorials/transactables/removing-transactable)
* [Sign Up Form](/tutorials/users/creating-sign-up-form#step-2-configure-forms)
* [Recover Password Form](/tutorials/users/resetting-password-authenticated-user#step-2-create-form-to-get-user-email)
* [Custom Images](/tutorials/properties/custom-images#form-configuration)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,4 @@ callback: "{%- assign response_json = response.body | to_hash -%}{% execute_quer
{% endraw %}
```


## Next steps

Congratulations! You know how to parse an API response. Now you can learn about Transactables.

* [Transactables](/tutorials/transactables/transactables)

{% include 'shared/questions_section' %}

This file was deleted.

This file was deleted.

This file was deleted.