Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 0 additions & 80 deletions docs/foundations/core-concepts.md

This file was deleted.

101 changes: 0 additions & 101 deletions docs/foundations/harper-architecture.md

This file was deleted.

80 changes: 0 additions & 80 deletions docs/foundations/use-cases.md

This file was deleted.

18 changes: 18 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,17 @@ const config: Config = {
onBrokenMarkdownLinks: 'warn',

plugins: [
// Learn documentation
[
'@docusaurus/plugin-content-docs',
{
id: 'learn',
path: 'learn',
routeBasePath: 'learn',
sidebarPath: './sidebarsLearn.ts',
editUrl: 'https://github.com/HarperDB/documentation/blob/main/',
},
],
// Main documentation
[
'@docusaurus/plugin-content-docs',
Expand Down Expand Up @@ -305,6 +316,13 @@ const config: Config = {
href: 'https://www.harper.fast/',
},
items: [
{
type: 'docSidebar',
sidebarId: 'learnSidebar',
docsPluginId: 'learn',
position: 'left',
label: 'Learn',
},
{
type: 'docSidebar',
sidebarId: 'docsSidebar',
Expand Down
1 change: 1 addition & 0 deletions learn/administration/coming-soon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Coming Soon
1 change: 1 addition & 0 deletions learn/developers/coming-soon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Coming Soon
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,55 @@
title: Install and Connect Harper
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Install and Connect Harper

The recommended approach for efficiently developing applications with Harper is to install Harper locally for efficient development of an application and deploy it to [Harper Fabric](https://fabric.harper.fast), our distributed data application platform service. However, you can also develop directly in Fabric, if you want to quickly try it out. You can also run a self-hosted Harper server, and manage it with our Fabric studio management UI.
Developers have two recommended approaches for developing Harper applications; either locally or with [Harper Fabric](https://fabric.harper.fast), our distributed data application platform service. If you start developing locally, you can always switch to Fabric by deploying your application. If you're interested in setting up a Fabric instance, navigate to the [Fabric](../../fabric/index.md) part of the documentation, and then come back after you have created your first Fabric cluster.

## Install Harper Locally

## Install with npm
Harper is published to the npm registry and requires Node.js current, active LTS, or maintenance LTS versions to run.

The fastest way to get Harper running locally is to install with npm. Make sure you have [Node.js](https://nodejs.org/) (LTS or newer). Then run:
The fastest way to get started is by installing Harper globally using an npm compatible package manager:

```bash
npm install -g harperdb
harperdb
npm install -g harper
```

The first time, you’ll set up your destination, username, password, and [configuration](../deployments/configuration). That’s it! Harper is now running locally.
Then, execute the Harper CLI to start the interactive installation process:

```bash
harper install
```

✅ Quick check: open http://localhost:9925, which will launch the studio UI for managing your local server, or run this for a quick health check:
After completing the installation, run within the current command process using:

```bash
curl http://localhost:9925/health
harper
```

Harper can also be [installed with our Docker image or you can download Harper for manual or offline installation](../deployments/install-harper).
To check if everything is configured correctly and ready to go for development, run a quick health check using the `/health` endpoint available within the Operations API server.

:::note
If you configured a different Operations API port, use that instead of `9925` here.
:::

<Tabs>
<TabItem value="curl">
```bash
curl http://localhost:9925/health
```
</TabItem>
<TabItem value="fetch">
```typescript
const response = await fetch('http://localhost:9925/health');
const text = await response.text();
console.log(text);
```
</TabItem>
</Tabs>

## Manage and Deploy with Fabric

Expand All @@ -44,7 +71,3 @@ Once Harper is running or you are connected to Fabric, we recommend that you wal
- Explore the [Core Concepts](../foundations/core-concepts)
- Learn about [Harper's architecture](../foundations/harper-architecture)
- Review [Configuration options](../deployments/configuration)

:::info
Need help? Please don’t hesitate to [reach out](https://www.harpersystems.dev/contact).
:::
File renamed without changes.
Loading
Loading