@harperfast/template-react-studio 0.13.1 → 1.0.0

package/AGENTS.md

@@ -6,16 +6,17 @@ This repository contains "skills" that guide AI agents in developing Harper appl
 
 - [Adding Tables with Schemas](skills/adding-tables-with-schemas.md): Learn how to define schemas and enable automatic REST APIs for your database tables with schema .graphql files in Harper.
 - [Automatic APIs](skills/automatic-apis.md): Details on the CRUD endpoints automatically generated for exported tables with REST and WebSockets.
-- [Querying REST APIs](skills/querying-rest-apis.md): How to use filters, operators, sorting, and pagination in REST requests.
-- [Programmatic Table Requests](skills/programmatic-table-requests.md): How to use filters, operators, sorting, and pagination in programmatic table requests.
+- [Caching](skills/caching.md): How caching is defined and implemented in Harper applications.
+- [Checking Authentication](skills/checking-authentication.md): How to use sessions to verify user identity and roles.
 - [Custom Resources](skills/custom-resources.md): How to define custom REST endpoints using JavaScript or TypeScript (Note: Paths are case-sensitive).
-- [Extending Table Resources](skills/extending-tables.md): Adding custom logic to automatically generated table resources.
 - [Defining Relationships](skills/defining-relationships.md): Using the `@relationship` directive to link tables.
-- [Real-time Applications](skills/real-time-apps.md): Implementing WebSockets and Pub/Sub for live data updates.
-- [TypeScript Type Stripping](skills/typescript-type-stripping.md): Using TypeScript directly without build tools via Node.js Type Stripping.
+- [Deploying to Harper Fabric](skills/deploying-to-harper-fabric.md): Globally scaling your Harper application with our generous Free tier and beyond.
+- [Extending Table Resources](skills/extending-tables.md): Adding custom logic to automatically generated table resources.
 - [Handling Binary Data](skills/handling-binary-data.md): How to store and serve binary data like images or MP3s.
+- [Programmatic Table Requests](skills/programmatic-table-requests.md): How to use filters, operators, sorting, and pagination in programmatic table requests.
+- [Querying REST APIs](skills/querying-rest-apis.md): How to use filters, operators, sorting, and pagination in REST requests.
+- [Real-time Applications](skills/real-time-apps.md): Implementing WebSockets and Pub/Sub for live data updates.
 - [Serving Web Content](skills/serving-web-content): Two ways to serve web content from a Harper application.
-- [Checking Authentication](skills/checking-authentication.md): How to use sessions to verify user identity and roles.
-- [Caching](skills/caching.md): How caching is defined and implemented in Harper applications.
+- [TypeScript Type Stripping](skills/typescript-type-stripping.md): Using TypeScript directly without build tools via Node.js Type Stripping.
 - [Using Blobs](skills/using-blob-datatype.md): How to store and retrieve large data in HarperDB.
 - [Vector Indexing](skills/vector-indexing.md): How to define and use vector indexes for efficient similarity search.

package/README.md

@@ -6,17 +6,64 @@ Here's what you should do next:
 
 ### Define Your Schema
 
-Tap [+ New Table](./schemas/examplePeople.graphql?ShowNewTableModal=true) when viewing a schema file, and you'll be guided through the available options.
+1. Create a new [yourTableName.graphql](./schemas?ShowAddDirectoryOrFileModalType=file) file in the [schemas](./schemas) directory.
+2. Craft your schema by hand or tap "+ New Table" in the action bar for a bit of guidance.
+3. Save your changes.
+4. Tap "Restart Cluster" and your changes will be live!
 
-The [schemas/examplePeople.graphql](./schemas/examplePeople.graphql) is an example table schema definition. This is the main starting point for defining your [database schema](./databases), specifying which tables you want and what attributes/fields they should have.
-
-Open your [schemas/examplePeople.graphql](./schemas/examplePeople.graphql) to take a look at an example schema. You can add as many table definitions to a single schema file as you want. You can also create one file per schema.
-
-These schemas are the heart of a great Harper app. This is the main starting point for defining your [database schema](./databases), specifying which tables you want and what attributes/fields they should have. REST endpoints will get stood up for any table that you `@export`.
+These schemas are the heart of a great Harper app, specifying which tables you want and what attributes/fields they should have. Any table you `@export` stands up [REST endpoints automatically](./skills/automatic-rest-apis.md).
 
 ### Add Custom Endpoints
 
-The [resources/greeting.js](./resources/greeting.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.
+1. Create a new [greeting.js](./resources?ShowAddDirectoryOrFileModalType=file) file in the [resources](./resources) directory.
+
+2. Customize your resource:
+
+   ```javascript
+   export class Greeting extends Resource {
+   	static loadAsInstance = false;
+
+   	async post(
+   		target,
+   		newRecord,
+   	) {
+   		// By default, only super users can access these endpoints.
+   		return { greeting: 'Greetings, post!' };
+   	}
+
+   	async get(target) {
+   		// But if we want anyone to be able to access it, we can turn off the permission checks!
+   		target.checkPermission = false;
+   		return { greeting: 'Greetings, get! ' + process.version };
+   	}
+
+   	async put(
+   		target,
+   		record,
+   	) {
+   		target.checkPermission = false;
+   		if (this.getCurrentUser()?.name?.includes('Coffee')) {
+   			// You can add your own authorization guards, of course.
+   			return new Response('Coffee? COFFEE?!', { status: 418 });
+   		}
+   		return { greeting: 'Sssssssssssssss!' };
+   	}
+
+   	async patch(
+   		target,
+   		record,
+   	) {
+   		return { greeting: 'We can make this work!' };
+   	}
+
+   	async delete(target) {
+   		return true;
+   	}
+   }
+   ```
+
+3. Save your changes.
+4. Tap "Restart Cluster" and your changes will be live!
 
 ### View Your Website
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harperfast/template-react-studio",
-	"version": "0.13.1",
+	"version": "1.0.0",
 	"type": "module",
 	"repository": "github:HarperFast/create-harper",
 	"scripts": {},

package/skills/deploying-to-harper-fabric.md

@@ -0,0 +1,20 @@
+# Deploying to Harper Fabric
+
+To deploy your application to Harper Fabric, follow these steps:
+
+1. **Sign up**: Create an account at [https://fabric.harper.fast](https://fabric.harper.fast) and create a cluster.
+
+2. **Configure Environment**: Add your credentials and cluster URL to your `.env` file:
+   ```bash
+   # Deployments
+   CLI_TARGET_USERNAME='YOUR_CLUSTER_USERNAME'
+   CLI_TARGET_PASSWORD='YOUR_CLUSTER_PASSWORD'
+   CLI_TARGET='YOUR_FABRIC.HARPER.FAST_CLUSTER_URL_HERE'
+   ```
+
+3. **Deploy Locally**: Run the following command to deploy from your local environment:
+   ```bash
+   npm run deploy
+   ```
+
+4. **Set up CI/CD**: Customize the included `.github/workflow/deploy.yaml` file and define your secrets in your GitHub repository's action settings to enable continuous deployment.