docsify added

blocklessnetwork · Oct 11, 2024 · e513c4b · e513c4b
1 parent 0c9d264
commit e513c4b
Show file tree

Hide file tree

Showing 51 changed files with 635 additions and 0 deletions.
diff --git a/src/.nojekyll b/src/.nojekyll
diff --git a/src/README.md b/src/README.md
@@ -0,0 +1 @@
+# Blockless Docs
diff --git a/src/_sidebar.md b/src/_sidebar.md
@@ -0,0 +1,26 @@
+
+* [BLOCKLESS DOCS](/)
+
+* [Installation](installation/)
+
+* [Quick Start](quick-start/)
+
+* [Tutorials](tutorials/)
+  * [Function Site Deploy](tutorials/function-site-deploy.md)
+  * [Static Site Deploy](tutorials/static-site-deploy.md)
+  * [Static Site Dynamic Routes](tutorials/static-site-dynamic-routes.md)
+
+* [Core Concepts](core-concepts/)
+
+<!-- * [Developer Tools](developer-tools/)
+  * [B7S](developer-tools/)
+  * [CLI](developer-tools/)
+  * [BLS Runtime](developer-tools/)
+  * [B7S Browser Extension](developer-tools/) -->
+
+<!-- * [SDKs](sdks/)
+  * [AssemblyScript](sdks/)
+  * [TypeScript](sdks/)
+  * [Rust](sdks/)
+  * [Go](sdks/) -->
+
diff --git a/src/core-concepts/README.md b/src/core-concepts/README.md
@@ -0,0 +1,3 @@
+<!-- Core Concepts -->
+
+[core-concepts](../pages/protocol/core-concepts.md ':include')
diff --git a/src/index.html b/src/index.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Document</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+    <!-- Plugins CSS -->
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/sidebar-folder.min.css" />
+  </head>
+  <body>
+    <div id="app">
+    </div>
+    <script>
+      window.$docsify = {
+        name: "",
+        repo: "",
+        loadSidebar: true,
+        subMaxLevel: 2,
+        auto2top: true,
+        routerMode: 'hash',
+      };
+    </script>
+
+    <!-- Docsify v4 -->
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+    <!-- Plugins -->
+    <script src="//cdn.jsdelivr.net/gh/jackbentley/docsify-sidebar-collapse@build/dist/docsify-sidebar-collapse.min.js"></script>
+
+  </body>
+</html>
diff --git a/src/installation/README.md b/src/installation/README.md
@@ -0,0 +1,11 @@
+# Installation
+
+## Step 1
+
+## Step 2
+
+## Step 3
+
+## Step 4
+
+## Step 5
diff --git a/src/pages/network/_meta.json → src/pages/developer-tools/network/_meta.json b/src/pages/network/_meta.json → src/pages/developer-tools/network/_meta.json
diff --git a/src/pages/network/economics/_meta.json → ...eloper-tools/network/economics/_meta.json b/src/pages/network/economics/_meta.json → ...eloper-tools/network/economics/_meta.json
diff --git a/...ages/network/economics/token-economics.md → ...ools/network/economics/token-economics.md b/...ages/network/economics/token-economics.md → ...ools/network/economics/token-economics.md
diff --git a/src/pages/network/extensions.md → ...ges/developer-tools/network/extensions.md b/src/pages/network/extensions.md → ...ges/developer-tools/network/extensions.md
diff --git a/src/pages/network/function-manifest.md → ...eloper-tools/network/function-manifest.md b/src/pages/network/function-manifest.md → ...eloper-tools/network/function-manifest.md
diff --git a/...ges/network/functions-workflow/_meta.json → ...ols/network/functions-workflow/_meta.json b/...ges/network/functions-workflow/_meta.json → ...ols/network/functions-workflow/_meta.json
diff --git a/...pages/network/functions-workflow/index.md → ...tools/network/functions-workflow/index.md b/...pages/network/functions-workflow/index.md → ...tools/network/functions-workflow/index.md
diff --git a/...etwork/functions-workflow/passing-data.md → ...etwork/functions-workflow/passing-data.md b/...etwork/functions-workflow/passing-data.md → ...etwork/functions-workflow/passing-data.md
diff --git a/...ork/functions-workflow/requesting-data.md → ...ork/functions-workflow/requesting-data.md b/...ork/functions-workflow/requesting-data.md → ...ork/functions-workflow/requesting-data.md
diff --git a/src/pages/network/index.md → src/pages/developer-tools/network/index.md b/src/pages/network/index.md → src/pages/developer-tools/network/index.md
diff --git a/src/pages/network/quick-start.md → ...es/developer-tools/network/quick-start.md b/src/pages/network/quick-start.md → ...es/developer-tools/network/quick-start.md
diff --git a/src/pages/network/tutorials/_meta.json → ...eloper-tools/network/tutorials/_meta.json b/src/pages/network/tutorials/_meta.json → ...eloper-tools/network/tutorials/_meta.json
diff --git a/...rials/assets/img/dashboard-overview-1.png → ...rials/assets/img/dashboard-overview-1.png b/...rials/assets/img/dashboard-overview-1.png → ...rials/assets/img/dashboard-overview-1.png
diff --git a/...torials/assets/img/dashboard-overview.png → ...torials/assets/img/dashboard-overview.png b/...torials/assets/img/dashboard-overview.png → ...torials/assets/img/dashboard-overview.png
diff --git a/...torials/assets/img/login-verification.png → ...torials/assets/img/login-verification.png b/...torials/assets/img/login-verification.png → ...torials/assets/img/login-verification.png
diff --git a/...assets/img/login-with-crypto-wallet-1.png → ...assets/img/login-with-crypto-wallet-1.png b/...assets/img/login-with-crypto-wallet-1.png → ...assets/img/login-with-crypto-wallet-1.png
diff --git a/...assets/img/login-with-crypto-wallet-2.png → ...assets/img/login-with-crypto-wallet-2.png b/...assets/img/login-with-crypto-wallet-2.png → ...assets/img/login-with-crypto-wallet-2.png
diff --git a/...s/assets/img/login-with-crypto-wallet.png → ...s/assets/img/login-with-crypto-wallet.png b/...s/assets/img/login-with-crypto-wallet.png → ...s/assets/img/login-with-crypto-wallet.png
diff --git a/...rials/assets/img/react-dynamic-routes.png → ...rials/assets/img/react-dynamic-routes.png b/...rials/assets/img/react-dynamic-routes.png → ...rials/assets/img/react-dynamic-routes.png
diff --git a/...s/assets/img/vite-static-site-preview.png → ...s/assets/img/vite-static-site-preview.png b/...s/assets/img/vite-static-site-preview.png → ...s/assets/img/vite-static-site-preview.png
diff --git a/...tutorials/assets/img/vite-static-site.png → ...tutorials/assets/img/vite-static-site.png b/...tutorials/assets/img/vite-static-site.png → ...tutorials/assets/img/vite-static-site.png
diff --git a/...assets/img/your-project-name-deployed.png → ...assets/img/your-project-name-deployed.png b/...assets/img/your-project-name-deployed.png → ...assets/img/your-project-name-deployed.png
diff --git a/...network/tutorials/function-site-deploy.md → ...network/tutorials/function-site-deploy.md b/...network/tutorials/function-site-deploy.md → ...network/tutorials/function-site-deploy.md
diff --git a/src/pages/network/tutorials/index.md → ...eveloper-tools/network/tutorials/index.md b/src/pages/network/tutorials/index.md → ...eveloper-tools/network/tutorials/index.md
diff --git a/.../network/tutorials/serverless-todo-app.md → .../network/tutorials/serverless-todo-app.md b/.../network/tutorials/serverless-todo-app.md → .../network/tutorials/serverless-todo-app.md
diff --git a/...s/network/tutorials/static-site-deploy.md → ...s/network/tutorials/static-site-deploy.md b/...s/network/tutorials/static-site-deploy.md → ...s/network/tutorials/static-site-deploy.md
diff --git a/...k/tutorials/static-site-dynamic-routes.md → ...k/tutorials/static-site-dynamic-routes.md b/...k/tutorials/static-site-dynamic-routes.md → ...k/tutorials/static-site-dynamic-routes.md
diff --git a/src/quick-start/README.md b/src/quick-start/README.md
@@ -0,0 +1,15 @@
+# Quick start
+
+## Step 1
+
+## Step 2
+
+## Step 3
+
+## Step 4
+
+## Step 5
+
+cd src && python -m SimpleHTTPServer 3000
+
+kill -9 $(lsof -i:3000 -t)
diff --git a/src/quick-start/examples.md b/src/quick-start/examples.md
@@ -0,0 +1,3 @@
+# Examples
+
+## New Examples
diff --git a/src/quick-start/legal.md b/src/quick-start/legal.md
@@ -0,0 +1,4 @@
+# Legal
+
+## New Legal
+
diff --git a/src/quick-start/support.md b/src/quick-start/support.md
@@ -0,0 +1,4 @@
+# Support
+
+## New Support
+
diff --git a/src/tutorials/README.md b/src/tutorials/README.md
@@ -0,0 +1,71 @@
+# Tutorials
+
+Explore the Blockless Function and Static Site tutorials and get started on a sample project.
+
+## Start a New Project with the Blockless CLI
+
+First you will need to install the The Blockless Command Line Interface (CLI). This tool allows you to interact with the Blockless Network and manage your applications from the command line.
+
+## Install the Blockless CLI
+
+To install the Blockless CLI, you can either use `curl` or `wget`.
+
+Installing Blockless CLI with `curl`:
+
+```bash
+sudo sh -c "curl https://raw.githubusercontent.com/BlocklessNetwork/cli/main/download.sh | bash"
+```
+
+Installing Blockless CLI with `wget`:
+
+```bash
+sudo sh -c "wget <https://raw.githubusercontent.com/BlocklessNetwork/cli/main/download.sh> -v -O download.sh; chmod +x download.sh; ./download.sh; rm -rf download.sh"
+```
+
+To install on Windows, go to the [releases page](https://github.com/blocklessnetwork/cli/releases) on GitHub and download the x86 version of the Blockless CLI.
+
+## Get Familiar with Blockless CLI Commands
+
+To see a list of available commands, you can run the `bls` or `bls help` command:
+
+```bash
+bls help
+```
+
+## Login into the Blockless Network
+
+```bash
+bls login
+```
+
+You will be prompted to navigate to your localhost and connect your wallet.
+
+```bash
+Open Browser at http://0.0.0.0:8651 to complete login
+-OR- Open Browser at http://127.0.0.1:8651 to complete login
+```
+
+This will redirect you to the https://dashboard.blockless.network page where you can connect your preferred wallet.
+
+![login page](./assets/img/login-with-crypto-wallet.png "Login with Crypto Wallet")
+
+![login page](./assets/img/login-with-crypto-wallet-1.png "Login with Crypto Wallet")
+
+![login page](./assets/img/login-with-crypto-wallet-2.png "Login with Crypto Wallet")
+
+You should see and verification message in your console.
+
+```bash
+Authentication Completed!
+You have successfully authenticated with the server.
+```
+
+You can always check if you are logged in with the following command:
+
+```bash
+bls whoami
+```
+
+![login verification](./assets/img/login-verification.png "Login verification")
+
+Proceed to the next tutorial to get started.
diff --git a/src/tutorials/assets/img/dashboard-overview-1.png b/src/tutorials/assets/img/dashboard-overview-1.png
diff --git a/src/tutorials/assets/img/dashboard-overview.png b/src/tutorials/assets/img/dashboard-overview.png
diff --git a/src/tutorials/assets/img/login-verification.png b/src/tutorials/assets/img/login-verification.png
diff --git a/src/tutorials/assets/img/login-with-crypto-wallet-1.png b/src/tutorials/assets/img/login-with-crypto-wallet-1.png
diff --git a/src/tutorials/assets/img/login-with-crypto-wallet-2.png b/src/tutorials/assets/img/login-with-crypto-wallet-2.png
diff --git a/src/tutorials/assets/img/login-with-crypto-wallet.png b/src/tutorials/assets/img/login-with-crypto-wallet.png
diff --git a/src/tutorials/assets/img/react-dynamic-routes.png b/src/tutorials/assets/img/react-dynamic-routes.png
diff --git a/src/tutorials/assets/img/vite-static-site-preview.png b/src/tutorials/assets/img/vite-static-site-preview.png
diff --git a/src/tutorials/assets/img/vite-static-site.png b/src/tutorials/assets/img/vite-static-site.png
diff --git a/src/tutorials/assets/img/your-project-name-deployed.png b/src/tutorials/assets/img/your-project-name-deployed.png
diff --git a/src/tutorials/function-site-deploy.md b/src/tutorials/function-site-deploy.md
@@ -0,0 +1,71 @@
+# Function Site Deploy
+
+This is a simple application that when deployed will repeat back the string given.
+
+## BLS Function Init
+
+Create a new functional project and give it a name.
+
+```bash
+bls function init --name <your-project-name>
+```
+
+Select a framework and hit enter.
+
+```bash
+? Pick a framework › - Use arrow-keys. Return to submit.
+❯   Assembly Script
+    Rust
+```
+
+Pick a the hello world starter template.
+
+```bash
+? Pick a starter template › - Use arrow-keys. Return to submit.
+❯   Hello World
+    Price Oracle
+```
+
+Change directory to your project's directory.
+
+```bash
+cd your-project-name
+```
+
+## BLS Function Invoke
+
+Test your project is working.
+
+```bash
+bls function invoke
+```
+
+You should see the following verification message in the console.
+
+```bash
+Build successful!
+
+Hello, world!
+```
+
+## BLS Function Deploy
+
+Deploy your function application to the Blockless Network.
+
+```bash
+bls function deploy
+```
+
+Navigate to https://dashboard.blockless.network/overview to  view your deployment.
+
+![dashboard overview 1](./assets/img/dashboard-overview.png "Dashboard overview")
+
+Select your project.
+
+![dashboard overview](./assets/img/dashboard-overview-1.png "Dashboard overview 1")
+
+Click on the `Invocation URL`.
+
+![Your project deployed](./assets/img/your-project-name-deployed.png "Your project deployed")
+
+Congratulations! You have successful deployed a project on the Blockless Network.
diff --git a/src/tutorials/static-site-deploy.md b/src/tutorials/static-site-deploy.md
@@ -0,0 +1,122 @@
+# Static Site Deploy
+
+This is a simple application that will deploy a static Vite web application.
+
+## BLS Sites
+
+Initialize your static site.
+
+```bash
+bls sites init
+```
+
+Name your site.
+
+```bash
+? What would you like to name your site? › <your-site-name>
+```
+
+Select the Blank (Vite) framework.
+
+```bash
+? Pick a framework › - Use arrow-keys. Return to submit.
+❯   Blank (Vite)
+    React
+    Next.js
+    Vue
+```
+
+Change directory to `your-site-name`.
+
+```bash
+cd your-site-name
+```
+
+Install dependencies.
+
+```bash
+npm Install
+```
+
+Run project.
+
+```bash
+npm run dev
+```
+
+You will be prompted to navigate to a localhost address.
+
+```bash
+  VITE v5.3.3  ready in 344 ms
+
+  ➜  Local:   http://localhost:5173/
+  ➜  Network: use --host to expose
+  ➜  press h + enter to show help
+```
+
+![vite static site](./assets/img/vite-static-site.png "Vite static site")
+
+You can now develop this Vite site as you would any other site. Once you are ready to deploy move to the next section.
+
+## BLS Sites Build
+
+Stop your development server by clicking on CTRL+C (macos).
+
+Build your site.
+
+```bash
+bls sites build
+```
+
+You will see a build success message in your console.
+
+```bash
+Build successful!
+```
+
+You are now ready to preview your static site locally.
+
+## BLS Sites Preview
+
+Preview your project locally. This will create the build that can be deployed to the Blockless Network and preview it locally.
+
+```bash
+bls sites preview
+```
+
+You should see the following success message in the console:
+
+```bash
+Serving http://127.0.0.1:3000 ...
+```
+
+Navigate to http://127.0.0.1:3000 to view your project.
+
+![vite static site preview](./assets/img/vite-static-site-preview.png "Vite static site preview")
+
+You are now ready to deploy!
+
+## BLS Sites Deploy
+
+Stop your development server by clicking on CTRL+C (macos).
+
+Deploy your static site to the Blockless Network.
+
+```bash
+bls sites deploy
+```
+
+You should see the following success message in the console:
+
+```bash
+Deployment successful!
+Name:   your-site-name
+URL:    https://your-site-name-acc53c4a.bls.dev
+CID:    bafybeib4fsqkqlup7nbuk7nhcvipue4y665rhxaeayzy63n62gkknqfjbq
+```
+
+Navigate to the URL shown in the console.
+
+![vite static site preview](./assets/img/vite-static-site-preview.png "Vite static site preview")
+
+Congratulations! You have successful deployed a static web application on the Blockless Network.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		<!-- Core Concepts -->

		[core-concepts](../pages/protocol/core-concepts.md ':include')