Skip to content

Commit 6348732

Browse files
authored
Merge pull request #172 from HarperDB/getting-started-4.5
Create new getting started guide
2 parents f34359b + b56bf2c commit 6348732

File tree

8 files changed

+409
-264
lines changed

8 files changed

+409
-264
lines changed

docs/README.md

Lines changed: 2 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4,61 +4,11 @@
44
[Connect with our team!](https://www.harpersystems.dev/contact)
55
{% endhint %}
66

7-
## What is Harper? Performance, Simplicity, and Scale.
8-
9-
Harper is an all-in-one backend technology that fuses database technologies, caching, application hosting, and messaging functions into a single system. Unlike traditional architectures where each piece runs independently and incurs extra costs and latency from serialization and network operations between processes, Harper systems can handle workloads seamlessly and efficiently.
10-
11-
Harper simplifies scaling with clustering and native data replication. At scale, architectures tend to include 4 to 16 redundant, geo-distributed nodes located near every user population center. This ensures that every user experiences minimal network latency and maximum reliability in addition to the already rapid server responses.
12-
13-
<figure><img src="../images/harperstack.jpg" alt="Comparison of Harper&#x27;s all-in-one technology (left) versus traditional multi-system approaches (right), highlighting Harper&#x27;s speed, simplicity, and efficiency with no intermediary processes, against the latency and complexity of legacy strategies."><figcaption></figcaption></figure>
14-
15-
## Understanding the Paradigm Shift
16-
17-
Have you ever combined MongoDB with Redis, Next.js with Postgres, or perhaps Fastify with anything else? The options seem endless. It turns out that the cost of serialization, network hops, and intermediary processes in these systems adds up to 50% of the total system resources used (often more). Not to mention the hundreds of milliseconds of latency they can add.
18-
19-
What we realized is that networking systems together in this way is inefficient and only necessary because a fused technology did not exist. So, we built Harper, a database fused with a complete JavaScript application system. It’s not only orders of magnitude more performant than separated systems, but it’s also easier to deploy and manage at scale.
20-
21-
## Build With Harper
22-
23-
Start by running Harper locally with [npm](https://www.npmjs.com/package/harperdb) or [Docker](https://hub.docker.com/r/harperdb/harperdb).
24-
25-
Since technology tends to be built around the storage, processing, and transfer of data, start by [defining your schema](developers/applications/#creating-our-first-table) with the `schema.graphql` file in the root of the application directory.
26-
27-
If you would like to [query](developers/applications/#adding-an-endpoint) this data, add the `@export` directive to our data schema and test out the [REST](developers/rest.md), [MQTT](developers/real-time.md#mqtt), or [WebSocket](developers/real-time.md#websockets) endpoints.
28-
29-
When you are ready for something a little more advanced, start [customizing your application](developers/applications/#custom-functionality-with-javascript).
30-
31-
Finally, when it’s time to deploy, explore [replication](developers/replication/) between nodes.
32-
33-
If you would like to jump into the most advanced capabilities, learn about [components](developers/components/).
34-
35-
For a more comprehensive deep dive, take a look at our [Getting Started Guide](getting-started.md).
36-
37-
{% hint style="warning" %}
38-
Need help? Please don’t hesitate to [reach out](https://www.harpersystems.dev/contact).
39-
{% endhint %}
40-
41-
## Popular Use Cases
42-
43-
With so much functionality built in, the use cases span nearly all application systems. Some of the most popular are listed below, motivated by new levels of performance and system simplicity.
44-
45-
### Online Catalogs & Content Delivery
46-
47-
For use cases like e-commerce, real estate listing, and content-oriented sites, Harper’s breakthroughs in performance and distribution pay dividends in the form of better SEO and higher conversion rates. One common implementation leverages Harper’s [Next.js Component](https://github.com/HarperDB/nextjs) to host modern, performant frontend applications. Other implementations leverage the built-in caching layer and JavaScript application system to [server-side render pages](https://www.harpersystems.dev/development/tutorials/server-side-rendering-with-multi-tier-cache) that remain fully responsive because of built-in WebSocket connections.
48-
49-
### Data Delivery Networks
50-
51-
For use cases like real-time sports updates, flight tracking, and zero-day software update distribution, Harper is rapidly gaining popularity. Harper’s ability to receive and broadcast messages while simultaneously handling application logic and data storage streamlines operations and eliminates the need for multiple separate systems. To build an understanding of our messaging system function, refer to our [real-time documentation](developers/real-time.md).
52-
53-
### Edge Inference Systems
54-
55-
Capturing, storing, and processing real-time data streams from client and IoT systems typically requires a stack of technology. Harper’s selective data replication and self-healing connections make for an ideal multi-tier system where edge and cloud systems both run Harper, making everything more performant.
56-
57-
[We’re happy](https://www.harpersystems.dev/contact) to walk you through how to do this.
7+
Welcome to the Harper Documentation! Here, you'll find all things Harper, and everything you need to get started, troubleshoot issues, and make the most of our platform.
588

599
## Getting Started
6010

61-
<table data-column-title-hidden data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="getting-started.md"><strong>Getting Started Guide</strong></a></td><td>Get up and running with Harper</td><td></td><td><a href="getting-started.md">getting-started.md</a></td></tr><tr><td><a href="deployments/install-harper/"><strong>Quick Install Harper</strong></a></td><td>Run Harper on your on hardware</td><td></td><td><a href="deployments/install-harper/">install-harper</a></td></tr><tr><td><a href="deployments/harper-cloud/"><strong>Try Harper Cloud</strong></a></td><td>Spin up an instance in minutes to get going fast</td><td></td><td><a href="deployments/harper-cloud/">harper-cloud</a></td></tr></tbody></table>
11+
<table data-column-title-hidden data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="getting-started/install-harper.md"><strong>Install Harper</strong></a></td><td>Pick the installation method that best suits your environment</td><td></td><td><a href="getting-started/install-harper.md">install-harper</a></td></tr><tr><td><a href="getting-started/what-is-harper.md"><strong>What is Harper</strong></a></td><td>Learn about Harper, how it works, and some of its usecases</td><td></td><td><a href="getting-started/what-is-harper.md">what-is-harper</a></td></tr><tr><td><a href="getting-started/harper-concepts.md"><strong>Harper Concepts</strong></a></td><td>Learn about Harper's fundamental concepts and how they interact</td><td></td><td><a href="getting-started/harper-concepts.md">harper-concepts</a></td></tr></tbody></table>
6212

6313
## Building with Harper
6414

docs/SUMMARY.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Table of contents
22

33
* [Harper Docs](README.md)
4-
* [Getting Started](getting-started.md)
4+
* [Getting Started](getting-started/README.md)
5+
* [What is Harper](getting-started/what-is-harper.md)
6+
* [Install Harper](getting-started/install-harper.md)
7+
* [Harper Concepts](getting-started/harper-concepts.md)
8+
* [Create Your First Application](getting-started/first-harper-app.md)
59

610
## Developers
711

0 commit comments

Comments
 (0)