Skip to content

Commit 0cf6aba

Browse files
committed
editing README.md
1 parent f4665ca commit 0cf6aba

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1-
# HarperDB Application Template
1+
# HarperDB Full Page/Partial Page Cache Application Template
2+
3+
This is a template for implementing full/partial page caching using HarperDB application component.
4+
5+
6+
This repo is a template to implement full-page/partial page caching using the HarperDB application component.
7+
8+
You can visit the links below to learn more about HarperDB and application components
9+
10+
- [HarperDB Application Component Github repo](https://github.com/HarperDB/application-template)
11+
-[HarperDB Documentation](https://docs.harperdb.io/docs/developers/applications)
12+
13+
214

3-
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:
415

5-
`harperdb run /path/to/your-app`
616

7-
(or if you enter that directory, you can run the current directory as `harperdb run .`).
817

9-
For more information about getting started with HarperDB and building applications, see our getting started guide.
1018

11-
This template includes the [default configuration](./config.yaml), which specifies how files are handled in your application.
1219

13-
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.
1420

15-
The [resources.js](./resources.js) provides a template for defining JavaScript resource classes, for customized application logic in your endpoints.

0 commit comments

Comments
 (0)