start work for launch

Author: manishrjain

docs/intro.md

@@ -4,44 +4,81 @@ sidebar_position: 1
 
 # Tutorial Intro
 
-Let's discover **Docusaurus in less than 10 minutes**.
+Let's discover **Outserv in less than 5 minutes.**
 
-## Getting Started
+## 0. Prerequisites
 
-Get started by **creating a new site**.
+:::tip Test Setup (July 2022)
 
-Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+- Go version 1.17.6
+- Node 16.14.2
+- Ubuntu 22.04 LTS
 
-### What you'll need
+:::
 
-- [Node.js](https://nodejs.org/en/download/) version 14 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+We recommend you use a Linux system to run Outserv. To run lambda functions, we
+recommend installing nodejs as well.
 
-## Generate a new site
+```bash
+sudo apt-get install nodejs
+```
+
+## Option 1.a) Download executable
+
+Download the Outserv binary from
+[releases](https://github.com/outcaste-io/outserv/releases) and place it in
+`/usr/bin` or `/usr/local/bin`.
+
+## Option 1.b) Build Outserv Yourself
+
+```bash
+sudo apt-get update
+sudo apt-get install gcc make golang
 
-Generate a new Docusaurus site using the **classic template**.
+git clone https://github.com/outcaste-io/outserv.git
+cd ./outserv
+git checkout v22.07.0
+make install
+```
+
+## 2. Run Outserv GraphQL
 
-The classic template will automatically be added to your project after you run the command:
+We will run Outserv with Lambdas. So, ensure that you have NodeJS installed.
 
 ```bash
-npm init docusaurus@latest my-website classic
+outserv graphql --lambda="num=2;" # Data would go into "data" dir.
 ```
 
-You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
+## 3. Load up GraphQL Schema and Lambdas
 
-The command also installs all necessary dependencies you need to run Docusaurus.
+You can pick up a GraphQL schema and Lambda code from
+[`importers/eth`](https://github.com/outcaste-io/outserv/blob/main/importers/eth),
+or use your own schema.
 
-## Start your site
+```bash
+curl -X POST http://localhost:8080/admin/schema --data-binary '@schema.graphql'
+curl -X POST http://localhost:8080/admin/lambda --data-binary '@lambda.js'
+```
 
-Run the development server:
+## 4. Run Ethereum loader
+
+You can either run geth locally, or you can use a geth gateway provided by
+Cloudflare, Alchemy, Infura or others. I recommend using GraphQL endpoint
+because that's [much
+faster](https://twitter.com/manishrjain/status/1546675483986710529) than
+JSON-RPC.
 
 ```bash
-cd my-website
-npm run start
+cd importers/eth
+go build . && ./eth --geth "GraphQL or JSON-RPC endpoint of Geth"
 ```
 
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+This would start loading ETH transactions into Outserv.
+
+
+## 5. You're ready
 
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
+You can now use any GraphQL editor (like Insomnia) to query Outserv at:
+`http://localhost:8080/graphql`. The editor would show the API documentation
+automatically.
 
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.

docusaurus.config.js

@@ -6,15 +6,15 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'My Site',
-  tagline: 'Dinosaurs are cool',
-  url: 'https://your-docusaurus-test-site.com',
+  title: 'Outserv',
+  tagline: 'Setup GraphQL Search APIs over Blockchain data 10x faster',
+  url: 'https://github.com/outcaste-io/outserv',
   baseUrl: '/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
-  organizationName: 'facebook', // Usually your GitHub org/user name.
-  projectName: 'docusaurus', // Usually your repo name.
+  organizationName: 'outcaste-io', // Usually your GitHub org/user name.
+  projectName: 'outserv', // Usually your repo name.
 
   presets: [
     [
@@ -24,14 +24,14 @@ const config = {
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
-          editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
-        },
-        blog: {
-          showReadingTime: true,
-          // Please change this to your repo.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+          editUrl: 'https://github.com/outcaste-io/outserv',
         },
+        // blog: {
+        //   showReadingTime: true,
+        //   // Please change this to your repo.
+        //   editUrl:
+        //     'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+        // },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
         },
@@ -43,21 +43,21 @@ const config = {
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
       navbar: {
-        title: 'My Site',
-        logo: {
-          alt: 'My Site Logo',
-          src: 'img/logo.svg',
-        },
+        title: 'Outserv',
+        // logo: {
+        //   alt: 'My Site Logo',
+        //   src: 'img/logo.svg',
+        // },
         items: [
           {
             type: 'doc',
             docId: 'intro',
             position: 'left',
-            label: 'Tutorial',
+            label: 'Docs',
           },
-          {to: '/blog', label: 'Blog', position: 'left'},
+          // {to: '/blog', label: 'Blog', position: 'left'},
           {
-            href: 'https://github.com/facebook/docusaurus',
+            href: 'https://github.com/outcaste-io/outserv',
             label: 'GitHub',
             position: 'right',
           },
@@ -78,17 +78,17 @@ const config = {
           {
             title: 'Community',
             items: [
-              {
-                label: 'Stack Overflow',
-                href: 'https://stackoverflow.com/questions/tagged/docusaurus',
-              },
+              // {
+              //   label: 'Stack Overflow',
+              //   href: 'https://stackoverflow.com/questions/tagged/docusaurus',
+              // },
               {
                 label: 'Discord',
-                href: 'https://discordapp.com/invite/docusaurus',
+                href: 'https://discord.gg/rmJnNd4XaV',
               },
               {
                 label: 'Twitter',
-                href: 'https://twitter.com/docusaurus',
+                href: 'https://twitter.com/manishrjain',
               },
             ],
           },
@@ -97,16 +97,16 @@ const config = {
             items: [
               {
                 label: 'Blog',
-                to: '/blog',
+                to: 'https://manishrjain.com',
               },
               {
                 label: 'GitHub',
-                href: 'https://github.com/facebook/docusaurus',
+                href: 'https://github.com/outcaste-io/outserv',
               },
             ],
           },
         ],
-        copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
+        copyright: `Copyright © ${new Date().getFullYear()} Outcaste LLC. Built with Docusaurus.`,
       },
       prism: {
         theme: lightCodeTheme,

src/components/HomepageFeatures/index.js

@@ -4,32 +4,33 @@ import styles from './styles.module.css';
 
 const FeatureList = [
   {
-    title: 'Easy to Use',
+    title: 'Blockchain Search',
     Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
     description: (
       <>
-        Docusaurus was designed from the ground up to be easily installed and
-        used to get your website up and running quickly.
+        Outserv's importers connect with any blockchain and index their data to
+        provide fast, production-grade search capabilities.
       </>
     ),
   },
   {
-    title: 'Focus on What Matters',
+    title: 'Fast GraphQL APIs',
     Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
     description: (
       <>
-        Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
-        ahead and move your docs into the <code>docs</code> directory.
+        Outserv generates GraphQL APIs out of the box and executes queries
+        within milliseconds. Extend these APIs with custom Javascript
+        code run by Outserv.
       </>
     ),
   },
   {
-    title: 'Powered by React',
+    title: 'Fast Setup',
     Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
     description: (
       <>
-        Extend or customize your website layout by reusing React. Docusaurus can
-        be extended while reusing the same header and footer.
+        Single downloadable binary can index 15 million Ethereum
+        blocks within hours, making it easy and fast to set up.
       </>
     ),
   },

src/pages/index.js

@@ -17,7 +17,7 @@ function HomepageHeader() {
           <Link
             className="button button--secondary button--lg"
             to="/docs/intro">
-            Docusaurus Tutorial - 5min ⏱️
+            Outserv Tutorial - 5 mins ⏱️
           </Link>
         </div>
       </div>