Skip to content

Commit 3ee176f

Browse files
committed
Address PR comments
1 parent e7cb936 commit 3ee176f

File tree

3 files changed

+4
-20
lines changed

3 files changed

+4
-20
lines changed

docs/getting-started/first-harper-app.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ Now let's create the business logic for our Book API by implementing a custom re
3939
export class Books extends Resource {
4040
// Get a book by ID or list all books
4141
async get() {
42-
console.log("GET request received");
4342
const id = this.getId();
4443

4544
if (id) {
@@ -54,9 +53,7 @@ export class Books extends Resource {
5453
}
5554

5655
// Create a new book
57-
async post(data) {
58-
console.log("POST request received");
59-
56+
async post(data) {
6057
// Parse string data if needed
6158
if (typeof data === "string") {
6259
try {
@@ -95,7 +92,6 @@ This line creates a custom `Books` class that extends Harper's built-in `Resourc
9592
### GET Method
9693
```js
9794
async get() {
98-
console.log("GET request received");
9995
const id = this.getId();
10096

10197
if (id) {
@@ -120,7 +116,6 @@ The `get()` method handles HTTP GET requests to our Book endpoint. It:
120116
### POST Method
121117
```js
122118
async post(data) {
123-
console.log("POST request received");
124119

125120
// Parse string data if needed
126121
if (typeof data === "string") {

docs/getting-started/harper-concepts.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,6 @@ A key aspect to components are their extensibility; components can be built on o
1010
## Applications
1111
Applications are a subset of components that cannot be used directly and must depend on other extensions. Examples include defining schemas (using [graphqlSchema](https://docs.harperdb.io/docs/developers/components/built-in#graphqlschema) built-in extension), defining custom resources (using jsResource built-in extension), hosting static files (using static built-in extension), enabling REST querying of resources (using rest built-in extension), and running Next.js, Astro, or Apollo applications through their respective extensions.
1212

13-
## Extensions
14-
A Harper Extension is an extensible component that is intended to be used by other components. The built-in components [graphqlSchema](https://docs.harperdb.io/docs/developers/components/built-in#graphqlschema) and [jsResource](https://docs.harperdb.io/docs/developers/components/built-in#jsresource) are both examples of extensions.
15-
16-
For now, there are two key types of Harper Extensions: Resource Extension and Protocol Extensions. The key difference is that a Protocol Extensions can return a Resource Extension.
17-
18-
### Resource Extension
19-
A resource extension is for processing file and directory entries. For example, the built-in jsResource extension handles executing JavaScript files, and the built-in graphql extension handles processing graphql schema files defining Harper resources.
20-
21-
### Protocol Extension
22-
A Protocol Extension is a more advanced form of a Resource Extension and is mainly used for implementing higher level protocols. For example, the [Harper Next.js Extension](https://github.com/HarperDB/nextjs) handles building and running a Next.js project by hooking the Next.js server into Harper's underlying HTTP and WS middleware system. A Protocol Extension is particularly useful for adding custom networking handlers (see the [server](https://docs.harperdb.io/docs/technical-details/reference/globals#server) global API documentation for more information).
23-
2413
## Resources
2514
Resources in Harper encompass databases, tables, and schemas that store and structure data within the system. The concept is central to Harper's data management capabilities, with custom resources being enabled by the built-in jsResource extension. Resources represent the data layer of the Harper ecosystem and provide the foundation for data operations across applications built with the platform.
2615

docs/getting-started/install-harper.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ docker run -d -p 9925:9925 harperdb/harperdb
3838

3939
In this command, the -d flag runs the container in detached mode, allowing it to operate in the background, and the -p 9925:9925 flag maps port 9925 on your local machine to port 9925 within the container, which is Harper’s default port. This port mapping lets you interact with the Harper instance directly from your local environment.
4040

41-
### How to Use This Image
41+
### How to Use this Image
4242
[Harper configuration settings⁠](https://harperdb.io/docs/reference/configuration-file/) can be passed as Docker run environment variables. If no environment variables are provided, Harper will operate with default configuration settings, such as:
4343
- ROOTPATH=/home/harperdb/hdb
4444
- OPERATIONSAPI_NETWORK_PORT=9925
@@ -115,8 +115,8 @@ docker logs <container_id>
115115

116116
Once verified, you can access your Harper instance by opening your web browser and navigating to http://localhost:9925 (or the appropriate port based on your configuration).
117117

118-
### Offline Install
119-
If you need to install Harper on a device that doesn't have an Internet connection, you can choose your version and download the npm package and install it directly (you’ll still need Node.js and NPM). Click [this link](https://products-harperdb-io.s3.us-east-2.amazonaws.com/index.html) to download and install the package. Once you’ve downloaded the .tgz file, run the following command from the directory where you’ve placed it:
118+
### Raw binary installation
119+
There's a different way to install Harper. You can choose your version and download the npm package and install it directly (you’ll still need Node.js and NPM). Click [this link](https://products-harperdb-io.s3.us-east-2.amazonaws.com/index.html) to download and install the package. Once you’ve downloaded the .tgz file, run the following command from the directory where you’ve placed it:
120120

121121
```bash
122122
npm install -g harperdb-X.X.X.tgz harperdb install

0 commit comments

Comments
 (0)