Skip to content

Commit 4201ea4

Browse files
quick edits before format
1 parent 1417431 commit 4201ea4

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

learn/getting-started/create-your-first-application.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Create Your First Application
55
import Tabs from '@theme/Tabs';
66
import TabItem from '@theme/TabItem';
77

8-
With Harper successfully installed and setup, let's dive into building your first Harper Application, a simple REST API. Harper lets you build powerful APIs with minimal effort. In just a few minutes, you'll have a functional REST API with automatic validation, indexing, and querying—all without writing a single line of code.
8+
With Harper successfully installed and setup, let's dive into building your first Harper Application, a simple REST API. Harper lets you build powerful APIs with minimal effort.
99

1010
## What You Will Learn
1111

@@ -18,8 +18,7 @@ With Harper successfully installed and setup, let's dive into building your firs
1818

1919
## Prerequisites
2020

21-
- Working Harper Installation
22-
- Complete previous guide [Install and Connect Harper](./install-and-connect-harper)
21+
- Working Harper Installation (previous guide [Install and Connect Harper](./install-and-connect-harper))
2322

2423
## Harper Architecture
2524

@@ -57,7 +56,7 @@ Lets get started building your first Harper application!
5756
<Tabs groupId="installation">
5857
<TabItem value="local" label="Local Installation">
5958

60-
Get started by cloning the [`HarperFast/create-your-first-application`](https://github.com/HarperFast/create-your-first-application) repo and opening it your editor of choice. If you have installed Harper using a container, make sure to run this within the `dev/` directory that the container was mounted to.
59+
Get started by cloning the [`HarperFast/create-your-first-application`](https://github.com/HarperFast/create-your-first-application) repo and opening it your editor of choice. If you have installed Harper using a container, make sure to clone into the `dev/` directory that the container was mounted to.
6160

6261
```bash
6362
git clone https://github.com/HarperFast/create-your-first-application.git first-harper-app
@@ -124,7 +123,7 @@ type Dog @table {
124123
Harper's schema system piggybacks off of the standard GraphQL field types such as `String`, `Int`, and many more.
125124

126125
:::info
127-
The Harper schema system has a lot of great features for making it effortless to define tables. We'll get into more custom directives later.
126+
The Harper schema system has a lot of great features for making it effortless to define tables. We'll demonstrate more custom directives later.
128127
:::
129128

130129
Now you have a schema for a `Dog` table with four attributes `id`, `name`, `breed`, and `age`.
@@ -333,5 +332,5 @@ Fantastic work! You've successfully created your first Harper application. There
333332

334333
## Additional Resources
335334

336-
- [Table Schema](../../docs/developers/applications/defining-schemas.md) reference
337-
- [REST](../../docs/developers/rest.md) reference
335+
- [Table Schema](../../docs/developers/applications/defining-schemas) reference
336+
- [REST](../../docs/developers/rest) reference

learn/getting-started/install-and-connect-harper.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ This guide will demonstrate all three ways to get started as well as introduce s
1313

1414
## What You Will Learn
1515

16-
- How to install Harper locally
16+
- How to install Harper locally using a Node.js package manager or a container
1717
- How to use the `harperdb` CLI
1818
- How to get setup using Harper Fabric
19-
- How to install and setup Harper as a container
2019
- How to perform a health check using the built-in Harper Operations API health endpoint
2120

2221
## Prerequisites
@@ -28,7 +27,7 @@ Like the [Welcome](../) page stated, all guide pages require a set of system pre
2827
## Local installation and setup
2928

3029
:::note
31-
If you want to use the cloud-hosted, platform service Harper Fabric instead of a local installation, skip ahead to the [Getting started with Fabric](#get-started-with-fabric) section.
30+
If you want to use the cloud-hosted, platform service Harper Fabric instead of a local installation, skip ahead to the [Getting started with Fabric](#getting-started-with-fabric) section.
3231
:::
3332

3433
<Tabs groupId="local-install">
@@ -201,7 +200,7 @@ This server does not have valid usage licenses, this should only be used for edu
201200

202201
This initial output contains a lot of helpful information. After the ASCII logo, there are a number of important log lines displaying the application process ID, the debugger endpoint, and domain socket path, and the Harper application version. Log lines are always prepended with the thread name, number, and then log level. `[main/0]` is the main thread, and `[http/1]` is the singular, additional worker thread. `[info]` is the default log level. After the log lines is specific application configuration information. It shows the application hostname, the number of worker threads, where Harper was installed, is the debugger enabled, logging level and location, and then ports, CORS, and socket path details for various networking protocols. We'll explain all of these in due time.
203202

204-
Interrupting the process (CTRL/CMD + C) will shut down Harper.
203+
Interrupting the process (`CTRL/CMD + C`) will shut down Harper.
205204

206205
With Harper successfully running, skip ahead to [Performing a health check](#performing-a-health-check) to learn how to verify your local Harper instance is running and complete this getting started guide. Or continue reading for more information on getting started with Harper Fabric.
207206

@@ -253,7 +252,7 @@ console.log(text);
253252

254253
</Tabs>
255254

256-
If you see `HarperDB is running.`, fantastic work! You've successfully installed and setup Harper. Continue on to the next part of the Getting Started section, [creating your first Harper application](./quickstart).
255+
If you see `HarperDB is running.`, fantastic work! You've successfully installed and setup Harper. Continue on to the next part of the Getting Started section, [creating your first Harper application](./create-your-first-application).
257256

258257
## Additional Resources
259258

0 commit comments

Comments
 (0)