Skip to content

Commit c0a813c

Browse files
progress
1 parent f8a24e2 commit c0a813c

File tree

2 files changed

+64
-17
lines changed

2 files changed

+64
-17
lines changed

learn/getting-started/installation.md renamed to learn/getting-started/install-and-connect-harper.mdx

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,55 @@
22
title: Install and Connect Harper
33
---
44

5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
7+
58
# Install and Connect Harper
69

7-
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.
10+
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.
11+
12+
## Install Harper Locally
813

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

11-
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:
16+
The fastest way to get started is by installing Harper globally using an npm compatible package manager:
1217

1318
```bash
14-
npm install -g harperdb
15-
harperdb
19+
npm install -g harper
1620
```
1721

18-
The first time, you’ll set up your destination, username, password, and [configuration](../deployments/configuration). That’s it! Harper is now running locally.
22+
Then, execute the Harper CLI to start the interactive installation process:
23+
24+
```bash
25+
harper install
26+
```
1927

20-
✅ 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:
28+
After completing the installation, run within the current command process using:
2129

2230
```bash
23-
curl http://localhost:9925/health
31+
harper
2432
```
2533

26-
Harper can also be [installed with our Docker image or you can download Harper for manual or offline installation](../deployments/install-harper).
34+
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.
35+
36+
:::note
37+
If you configured a different Operations API port, use that instead of `9925` here.
38+
:::
39+
40+
<Tabs>
41+
<TabItem value="curl">
42+
```bash
43+
curl http://localhost:9925/health
44+
```
45+
</TabItem>
46+
<TabItem value="fetch">
47+
```typescript
48+
const response = await fetch('http://localhost:9925/health');
49+
const text = await response.text();
50+
console.log(text);
51+
```
52+
</TabItem>
53+
</Tabs>
2754

2855
## Manage and Deploy with Fabric
2956

@@ -44,7 +71,3 @@ Once Harper is running or you are connected to Fabric, we recommend that you wal
4471
- Explore the [Core Concepts](../foundations/core-concepts)
4572
- Learn about [Harper's architecture](../foundations/harper-architecture)
4673
- Review [Configuration options](../deployments/configuration)
47-
48-
:::info
49-
Need help? Please don’t hesitate to [reach out](https://www.harpersystems.dev/contact).
50-
:::

learn/index.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,34 @@
22
title: Welcome to Harper Learn
33
---
44

5-
Welcome to Harper Learn!
5+
This documentation section contains thorough guides for learning how to develop and manage applications with Harper. The guides are present in a logical order to build up knowledge across Harper's vast feature set. The guides are example based and provide a hands-on approach to teaching and demonstrating key features. Guides can be referenced independently, but assume the reader is familiar with concepts presented in previous guides.
66

7-
This section contains thorough guides for learning how to build applications and more with Harper.
7+
For example, the [Loading Data]() guide assumes the reader already knows how to build a basic Harper application (covered in ), create databases and tables using schemas, and some basic query techniques. Those concepts are specifically covered throughout the [Getting Started](), [Key Harper Application Features](), and [Defining Databases and Tables]() guides.
88

9-
Each guide contains all necessary prerequisite and setup instructions for examples.
9+
Most guides present both local-based and [Harper Fabric]() cloud-based examples and instructions. Regardless, in order to properly complete all examples, we recommend the following prerequisite tools installed and configured on your local machine:
1010

11-
The guides are presented in a logical order to built up knowledge across Harper's vast features set. Guides can be referenced independently, but will assume the reader is familiar with concepts contained within previous guides. For example, the [Loading Data]() guide assumes the reader already knows how to build a basic Harper application, create databases and tables using schemas, and some basic query techniques. Those concepts are specifically covered throughout the [Getting Started](), [Key Harper Application Features](), and [Defining Databases and Tables]() guides.
11+
- Command line access and general file-system and networking permissions
12+
- `sudo` is not required
13+
- For local development, Harper requires permission to read/write files and localhost networking permissions
14+
- HTTP Client of choice
15+
- Most examples will present both curl and fetch based HTTP requests
16+
- GUI-based HTTP clients will also work fine and is left
17+
- Node.js Current, Active LTS, or Maintenance LTS version
18+
- For more information see [Node.js Releases](https://nodejs.org/en/about/previous-releases)
19+
- Verify your Node.js version by running `node -v` in the command line
20+
- Code editor of choice
21+
- Everything from `vim` to Visual Studio Code to WebStorm IDE will work fine for the purposes of these guides
22+
23+
If you ever have questions, join our official community [Discord](https://harper.fast/discord). Furthermore, Harper documentation is open source, if you notice anything out-of-place with the guide content, please [open an issue](https://github.com/HarperFast/documentation/issues) or submit changes directly using the "Edit this page" link at the bottom of every page.
24+
25+
26+
:::info
27+
28+
Eagle-eye developers may notice some things still reference Harper's previous name, HarperDB.
29+
30+
The "database" part is not gone, Harper has simply evolved to become so much more than _just_ a database.
31+
Harper is one-and-the-same with HarperDB, so please bare with us as we chip away at some renames.
32+
33+
:::
34+
35+
When you're ready to get started, click the "Next" tab below to begin your Harper adventure!

0 commit comments

Comments
 (0)