harperdb 4.5.9 → 4.5.11

package/README.md

@@ -66,4 +66,4 @@ harperdb
 Harper will prompt you for configuration options during install, and then automatically start after install.
 
 ---
-0cb5dbf3500f59efb0c7c7e2ecb27c9103a89031
+c0dd17d17c7a49f9c398b3b55a0cc73e652e7fa4

package/application-template/README.md

@@ -1,15 +1,33 @@
-# HarperDB Application Template
+# Harper Application Template
 
-This is a template for building [HarperDB](https://www.harperdb.io/) applications. You can download this repository as a starting point for building applications with HarperDB. To get started, make sure you have [installed HarperDB](https://docs.harperdb.io/docs/install-harperdb), which can be quickly done with `npm install -g harperdb`. You can run your application from the directory where you downloaded the contents of this repository with:
+This is a template for building [Harper](https://www.harpersystems.dev/) applications. You can download this repository as a starting point for building applications with Harper.
 
-`harperdb run /path/to/your-app`
+To get started, make sure you have [installed Harper](https://docs.harperdb.io/docs/deployments/install-harper), which can be quickly done with `npm install -g harperdb`.
 
-(or if you enter that directory, you can run the current directory as `harperdb run .`).
+You can run your application from the directory where you downloaded the contents of this repository with: `harperdb run /path/to/your-app`.
 
-For more information about getting started with HarperDB and building applications, see our getting started guide.
+Or if you set your current working directory to that directory, you can run it as `harperdb run .`.
 
-This template includes the [default configuration](./config.yaml), which specifies how files are handled in your application.
+Once running, test your application works by querying the `/Greeting` endpoint:
 
-The [schema.graphql](./schema.graphql) is the schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
+```sh
+curl http://localhost:9926/Greeting
+```
 
-The [resources.js](./resources.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
+Should result in:
+
+```json
+{"greeting":"Hello, world!"}
+```
+
+Or navigate to [http://localhost:9926](http://localhost:9926) in a browser and view the functional web application.
+
+For more information about getting started with HarperDB and building applications, see our [getting started guide](https://docs.harperdb.io/docs/getting-started).
+
+For more information on Harper Components, see the [Components documentation](https://docs.harperdb.io/docs/developers/components).
+
+This template includes a [default configuration](./config.yaml), which specifies how files are handled in your application.
+
+The [schema.graphql](./schema.graphql) is the table schema definition. This is the main starting point for defining your database schema, specifying which tables you want and what attributes/fields they should have.
+
+The [resources.js](./resources.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.

package/application-template/config.yaml

@@ -1,15 +1,18 @@
-# This defines the configuration of this application. Each defines a (sub) component that is loaded and
-# used for this application. These components can provide specific functionality and define how different
-# files in your app are loaded.
-rest: true  # This provides the HTTP REST interface for all exported resources
-graphqlSchema:  # These reads GraphQL schemas to define the schema of database/tables/attributes.
-  files: '*.graphql' # looks for these files
-  # path: / # exported queries are on the root path by default
-jsResource: # Loads JavaScript modules such that their exports are exported as resources
-  files: resources.js # the entry module for resources
-  # path: / # exported resources are on the root path by default, like http://server/resource-name
-static: # This allows static files to be directly accessible
-  root: web
-  files: web/**
-roles: # This can define the roles that are used in the application
-  files: roles.yaml
+# This is the configuration file for the application.
+# It specifies built-in Harper components that will load the specified feature and files.
+# For more information, see https://docs.harperdb.io/docs/developers/components/built-in
+
+# This provides the HTTP REST interface for all exported resources
+rest: true
+
+# These reads GraphQL schemas to define the schema of database/tables/attributes.
+graphqlSchema:
+  files: 'schema.graphql'
+
+# Loads JavaScript modules such that their exports are exported as resources
+jsResource:
+  files: 'resources.js'
+
+# Serve the static files from the web directory as a web application
+static:
+  files: 'web/*'

package/application-template/web/index.html

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Harper Application Template</title>
+    <link rel="stylesheet" href="styles.css" />
+  </head>
+  <body>
+    <main>
+      <h1>Harper Application Template</h1>
+      <p>
+        This is an example of serving static assets using the built-in
+        <a
+          href="https://docs.harperdb.io/docs/developers/components/built-in#static"
+          >static component</a
+        >. <br />
+        You can use this component to serve web applications!
+      </p>
+      <div>
+        <p class="count" id="count">0</p>
+        <button class="decrement" id="decrement">-</button>
+        <button class="increment" id="increment">+</button>
+      </div>
+    </main>
+
+    <script src="index.js"></script>
+  </body>
+</html>

package/application-template/web/index.js

@@ -0,0 +1,18 @@
+let count = 0;
+const counterDisplay = document.getElementById('count');
+const decrementButton = document.getElementById('decrement');
+const incrementButton = document.getElementById('increment');
+
+function updateDisplay() {
+	counterDisplay.textContent = count;
+}
+
+decrementButton.addEventListener('click', () => {
+	count--;
+	updateDisplay();
+});
+
+incrementButton.addEventListener('click', () => {
+	count++;
+	updateDisplay();
+});

package/application-template/web/styles.css

@@ -0,0 +1,57 @@
+body {
+  font-family: Arial, sans-serif;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  height: 100vh;
+  margin: 0;
+  background-color: #f5f5f5;
+}
+
+main {
+  text-align: center;
+  background-color: white;
+  padding: 2rem;
+  border-radius: 8px;
+  box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
+}
+
+.count {
+  font-size: 4rem;
+  margin: 1rem 0;
+  color: #333;
+}
+
+.counter-controls {
+  display: flex;
+  justify-content: center;
+  gap: 1rem;
+}
+
+button {
+  font-size: 1.5rem;
+  width: 3rem;
+  height: 3rem;
+  border: none;
+  border-radius: 50%;
+  cursor: pointer;
+  transition: background-color 0.2s;
+}
+
+.decrement {
+  background-color: #ff6b6b;
+  color: white;
+}
+
+.decrement:hover {
+  background-color: #ff5252;
+}
+
+.increment {
+  background-color: #4ecdc4;
+  color: white;
+}
+
+.increment:hover {
+  background-color: #39b2a9;
+}