initial commit

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/connecting/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "connecting",
+  "position": 2  
+}

docs/connecting/installation.md

@@ -0,0 +1,5 @@
+---
+sidebar_position: 1
+---
+
+# installation

docs/creating/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "creating",
+  "position": 4,
+  "link": {
+    "type": "generated-index"
+  }
+}

docs/creating/create-media.md

@@ -0,0 +1,5 @@
+---
+sidebar_position: 2
+---
+
+# media

docs/creating/create-thing.md

@@ -0,0 +1,5 @@
+---
+sidebar_position: 1
+---
+
+# thing

docs/intro.md

@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+# introduction
+
+welcome! this is the documentation for connecting and interacting with **everything**.
+
+**everything** is a framework for putting it all together. It provides methods for creating and querying data in both Web2 and Web3 for the development of real world applications, marketplaces, and services designed for the interconnected economy of tomorrow.

docs/playground/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "playground",
+  "position": 5,
+  "link": {
+    "type": "generated-index"
+  }
+}

docs/playground/connect.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 1
+---
+
+# connect
+
+Your everything account and corresponding NEAR wallet are your keys to interacting with the everything playground.
+While all functionalties of the playground require connecting an everything account, only marketplace functionalities require connecting a NEAR wallet.
+
+## everything account
+
+In order to utilize the playground's functionalities like creating a thing or media, you must first connect an everything account.
+
+From the playground's home page, click "connect" under "everything", which will redirect you to an Auth0 login screen. Either login to an existing account or sign up and create a new account.
+
+If the connection is successful, you should see a "you are logged in as {{nickname}}" message and the button changed to "disconnect".
+
+## NEAR wallet
+
+With an everything account connected, you must connect a NEAR wallet in order to utilize functionalities like minting and transacting.
+
+From the playground's home page, click "connect" under "NEAR", which will display a [NEAR wallet selector](https://github.com/near/wallet-selector). Either use the selector to connect your preferred wallet, or create a new wallet through the "NEAR Wallet" option. This will redirect your browser to the NEAR wallet and ask you to create a new wallet.
+
+If the connection is successful, you should see a "you are logged in as {{activeAccountId}}" message and the button changed to "disconnect".

docs/playground/create.md

@@ -0,0 +1,52 @@
+---
+sidebar_position: 2
+---
+
+# create
+
+The [create page](https://playground.everything.dev/create) on the playground allows you to interact with the everything sdk's main methods directly.
+These methods can be found in [@everything-sdk-js/sdk](https://github.com/near-everything/everything-sdk-js/tree/main/packages/sdk) package.
+
+## create thing
+
+:::caution
+
+An everything account must be connected in order to interact with this method.
+
+:::
+
+To create a thing, type or create an attribute under "select attributes". A new thing only requires one attribute and it's value to be provided -- this creates a characteristic that defines a thing.
+Once an attribute and value has been entered, select the storage (currently only supports "cloud") and click submit.
+
+The method will run and a response will be generated. If successful, then a UUID representing a thingId will be returned.
+This thingId will be used for the other methods.
+
+## create media
+
+:::caution
+
+An everything account must be connected in order to interact with this method.
+
+:::
+
+To create media, either select "camera" to take a picture or interact with the input to select or drag and drop your photos.
+Then, select the storage. Cloud will save the image to an Amazon S3 bucket while blockchain will save the image to [Arweave](https://www.arweave.org/).
+Paste the thingId into the input that you want the provided images to be associated with then click submit.
+
+The method will run and a response will be generated. If successful, then a list of urls representing the image references will be returned.
+No further action is necessary, the images have been associated with the thing.
+
+## mint thing
+
+:::caution
+
+A NEAR wallet must be connected in order to interact with this method.
+
+:::
+
+To mint a thing, paste the thingId into the input that you want minted and click submit.
+
+This will redirect you to a page where you must approve the mint.
+
+If successful, then you will be redirected back to the playground.
+No further action is necessary, a reference of the thing has been minted on chain.

docs/playground/explore.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 3
+---
+
+# explore
+
+The [explore page](https://playground.everything.dev/explore) on the playground allows you to query data from the [everything mesh](https://github.com/near-everything/mesh).
+These methods can be found in [@everything-sdk-js/data](https://github.com/near-everything/everything-sdk-js/tree/main/packages/data) package.
+
+## query data
+
+:::caution
+
+An everything account must be connected in order to interact with this feature.
+
+:::
+
+To query data, select a method from the drop down and then provide the supplemental parameters if necessary.
+
+Click "run query" to execute the query.
+
+The querie's response will be generated and displayed in the text box below.

docs/playground/transact.md

@@ -0,0 +1,120 @@
+---
+sidebar_position: 4
+---
+
+# transact
+
+The [transact page](https://playground.everything.dev/transact) on the playground allows you to transact on sample marketplaces.
+
+:::caution
+
+Both an everything account and a NEAR wallet must be connected in order to interact with this feature.
+
+:::
+
+The dashboard is broken down into 4 sections:
+
+  1. **personal inventory:** shows a user's owned things. This data is associated with the everything account and supplemented by the NEAR wallet.
+  2. **personal market:** a representation of a user's personal market. This market only shows products that the connected user owns and has listed.
+  3. **ecosystem market:** a representation of a market within the everything ecosystem. From the drop down, you can select sample marketplaces that represent exclusive marketplaces. These marketplaces feature listed products within the ecosystem that match a specific criteria.
+  4. **everything market:** shows the catch-all everything marketplace. This marketplace features all listed items across the entire ecosystem.
+
+If the personal inventory is empty, start by [creating a thing](#creating-a-thing).
+
+## creating a thing
+
+1. Click "create thing" within the personal inventory. This will bring up a modal prompting to provide an image and some attributes.
+2. Upload an image (preferrably one that represents a real, tangible asset) and type in some attributes. Then click submit and see the product appear in your personal inventory.
+
+### guided example
+
+1. Save the following image and upload into the photo box:
+
+![NEAR shirt](https://arweave.net/oNGd9-hZCRU8KEtTNQzDPvW8s7jG1foD_c-GaBBo9Do)
+
+2. Then, enter in some attributes:
+
+| Attribute | Value |
+| --- | --- |
+| Category | Clothing |
+| Subcategory | Tops |
+| Type | T-Shirt |
+| Brand | NEAR Protocol |
+
+3. Click submit to create the shirt and see it appear in your personal inventory.
+
+## minting a thing
+
+Assuming that an unminted thing exists in the personal inventory:
+
+1. Click the image to flip the card and expose the "MINT" button.
+2. Click "MINT" and this will redirect to NEAR wallet to approve the transaction.
+3. Approve the transaction.
+
+It may take a moment to take effect, but you should see the "MINT" button turn into a "LIST" button, signifying that the thing has been minted.
+
+## listing a thing
+
+:::info
+
+A thing can only be listed by the user that owns it and if it has already been minted.
+
+:::
+
+Listing requires storage.
+
+To deposit storage:
+
+1. Click the "deposit storage" button which will redirect to NEAR wallet.
+2. Approve the transaction
+
+Now you have storage available to list your things.
+
+To list:
+
+1. Click the image of a minted thing to flip the card and expose the "LIST" button.
+2. Click "LIST" and this will bring up a listing modal where you can enter in a price.
+3. Enter in a price or keep it at 0.
+4. Click submit. This will redirect to NEAR wallet to approve the listing.
+5. Approve the transaction.
+
+It may take a moment to take effect, but you should see the Thing appear in multiple approriate markets, signifying that the thing has been listed.
+
+## delisting a thing
+
+:::info
+
+A thing can only be delisted by the user that owns it and if it has already been listed.
+
+:::
+
+To delist:
+
+1. Click the image of a listed thing in your personal market to flip the card and expose the "DELIST" button.
+2. Click "DELIST" and this will redirect to NEAR wallet to approve the delisting.
+3. Approve the transaction.
+
+It may take a moment to take effect, but you should see the Thing disappear from the markets, signifying that the thing has been delisted.
+
+## buying a thing
+
+:::info
+
+A thing can only be bought by a user that does not own it and if it has already been listed.
+
+:::
+
+To buy:
+
+1. Click the image of an unowned thing in any of the markets to flip the card and expose the "BUY" button.
+2. Click "BUY" and this will redirect to NEAR wallet to approve the buy.
+3. Approve the transaction.
+
+It may take a moment to take effect, but you should see the Thing appear in your personal inventory and no longer appear in any of the markets, signifying that the thing has been bought.
+
+:::info
+
+There is a known bug that if the buy transaction fails, then the thing will still appear in the personal inventory and not be removed from any of the markets.
+We are working with Mintbase to fix this with their improved callback mechanism coming soon.
+
+:::

docs/reading/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "reading",
+  "position": 3,
+  "link": {
+    "type": "generated-index"
+  }
+}

docs/reading/data.md

@@ -0,0 +1,5 @@
+---
+sidebar_position: 1
+---
+
+# data