create-harper 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/README.md +5 -0
  2. package/index.js +37 -214
  3. package/lib/constants/defaultTargetDir.js +1 -0
  4. package/lib/constants/frameworks.js +75 -0
  5. package/lib/constants/helpMessage.js +23 -0
  6. package/lib/constants/renameFiles.js +7 -0
  7. package/lib/constants/templates.js +6 -0
  8. package/lib/fs/applyAndWriteTemplateFile.js +9 -0
  9. package/lib/fs/copy.js +11 -0
  10. package/lib/fs/copyDir.js +12 -0
  11. package/lib/fs/crawlTemplateDir.js +18 -0
  12. package/lib/fs/emptyDir.js +14 -0
  13. package/lib/fs/formatTargetDir.js +3 -0
  14. package/lib/fs/isEmpty.js +6 -0
  15. package/lib/install.js +17 -0
  16. package/lib/pkg/getInstallCommand.js +6 -0
  17. package/lib/pkg/getRunCommand.js +12 -0
  18. package/lib/pkg/isValidPackageName.js +5 -0
  19. package/lib/pkg/pkgFromUserAgent.js +9 -0
  20. package/lib/pkg/toValidPackageName.js +9 -0
  21. package/lib/run.js +14 -0
  22. package/lib/start.js +15 -0
  23. package/lib/steps/getEnvVars.js +79 -0
  24. package/lib/steps/getImmediate.js +29 -0
  25. package/lib/steps/getPackageName.js +38 -0
  26. package/lib/steps/getProjectName.js +40 -0
  27. package/lib/steps/getTemplate.js +65 -0
  28. package/lib/steps/handleExistingDir.js +61 -0
  29. package/lib/steps/scaffoldProject.js +40 -0
  30. package/lib/steps/showOutro.js +30 -0
  31. package/package.json +20 -8
  32. package/template-barebones/README.md +7 -0
  33. package/template-barebones/_aiignore +1 -0
  34. package/template-barebones/_env +3 -0
  35. package/template-barebones/_env.example +3 -0
  36. package/template-barebones/_gitignore +147 -0
  37. package/template-barebones/config.yaml +7 -0
  38. package/template-barebones/graphql.config.yml +3 -0
  39. package/template-barebones/package.json +14 -0
  40. package/template-barebones/schema.graphql +1 -0
  41. package/template-react/README.md +45 -0
  42. package/template-react/_aiignore +1 -0
  43. package/template-react/_env +3 -0
  44. package/template-react/_env.example +3 -0
  45. package/template-react/_github/workflow/deploy.yaml +40 -0
  46. package/template-react/_gitignore +147 -0
  47. package/template-react/config.yaml +23 -0
  48. package/template-react/deploy-template/config.yaml +2 -0
  49. package/template-react/deploy-template/fastify/static.js +14 -0
  50. package/template-react/deploy-template/package.json +5 -0
  51. package/template-react/graphql.config.yml +3 -0
  52. package/template-react/index.html +13 -0
  53. package/template-react/package.json +25 -0
  54. package/template-react/public/react.svg +14 -0
  55. package/template-react/public/typescript.svg +16 -0
  56. package/template-react/public/vite.svg +42 -0
  57. package/template-react/resources.js +27 -0
  58. package/template-react/schema.graphql +5 -0
  59. package/template-react/src/App.jsx +34 -0
  60. package/template-react/src/main.jsx +13 -0
  61. package/template-react/src/style.css +96 -0
  62. package/template-react/src/vite-env.d.ts +9 -0
  63. package/template-react/vite.config.js +22 -0
  64. package/template-react-ts/README.md +45 -0
  65. package/template-react-ts/_aiignore +1 -0
  66. package/template-react-ts/_env +3 -0
  67. package/template-react-ts/_env.example +3 -0
  68. package/template-react-ts/_github/workflow/deploy.yaml +40 -0
  69. package/template-react-ts/_gitignore +147 -0
  70. package/template-react-ts/config.yaml +23 -0
  71. package/template-react-ts/deploy-template/config.yaml +2 -0
  72. package/template-react-ts/deploy-template/fastify/static.js +14 -0
  73. package/template-react-ts/deploy-template/package.json +5 -0
  74. package/template-react-ts/graphql.config.yml +3 -0
  75. package/template-react-ts/index.html +13 -0
  76. package/template-react-ts/package.json +29 -0
  77. package/template-react-ts/public/react.svg +14 -0
  78. package/template-react-ts/public/typescript.svg +16 -0
  79. package/template-react-ts/public/vite.svg +42 -0
  80. package/template-react-ts/resources.ts +52 -0
  81. package/template-react-ts/schema.graphql +5 -0
  82. package/template-react-ts/src/App.tsx +34 -0
  83. package/template-react-ts/src/main.tsx +13 -0
  84. package/template-react-ts/src/style.css +96 -0
  85. package/template-react-ts/src/vite-env.d.ts +9 -0
  86. package/template-react-ts/tsconfig.json +34 -0
  87. package/template-react-ts/vite.config.ts +22 -0
  88. package/template-studio/README.md +34 -0
  89. package/template-studio/_aiignore +1 -0
  90. package/template-studio/_gitignore +147 -0
  91. package/template-studio/config.yaml +24 -0
  92. package/template-studio/graphql.config.yml +3 -0
  93. package/template-studio/package.json +14 -0
  94. package/template-studio/resources.js +27 -0
  95. package/template-studio/schema.graphql +7 -0
  96. package/template-studio/web/index.html +28 -0
  97. package/template-studio/web/index.js +18 -0
  98. package/template-studio/web/styles.css +57 -0
  99. package/template-studio-ts/README.md +34 -0
  100. package/template-studio-ts/_aiignore +1 -0
  101. package/template-studio-ts/_gitignore +147 -0
  102. package/template-studio-ts/config.yaml +24 -0
  103. package/template-studio-ts/graphql.config.yml +3 -0
  104. package/template-studio-ts/package.json +14 -0
  105. package/template-studio-ts/resources.ts +52 -0
  106. package/template-studio-ts/schema.graphql +7 -0
  107. package/template-studio-ts/tsconfig.json +10 -0
  108. package/template-studio-ts/web/index.html +28 -0
  109. package/template-studio-ts/web/index.js +18 -0
  110. package/template-studio-ts/web/styles.css +57 -0
  111. package/template-vanilla/README.md +57 -0
  112. package/template-vanilla/_aiignore +1 -0
  113. package/template-vanilla/_env +3 -0
  114. package/template-vanilla/_env.example +3 -0
  115. package/template-vanilla/_gitignore +147 -0
  116. package/template-vanilla/config.yaml +24 -0
  117. package/template-vanilla/graphql.config.yml +3 -0
  118. package/template-vanilla/package.json +14 -0
  119. package/template-vanilla/resources.js +27 -0
  120. package/template-vanilla/schema.graphql +7 -0
  121. package/template-vanilla/web/index.html +28 -0
  122. package/template-vanilla/web/index.js +18 -0
  123. package/template-vanilla/web/styles.css +57 -0
  124. package/template-vanilla-ts/README.md +57 -0
  125. package/template-vanilla-ts/_aiignore +1 -0
  126. package/template-vanilla-ts/_env +3 -0
  127. package/template-vanilla-ts/_env.example +3 -0
  128. package/template-vanilla-ts/_gitignore +147 -0
  129. package/template-vanilla-ts/config.yaml +24 -0
  130. package/template-vanilla-ts/graphql.config.yml +3 -0
  131. package/template-vanilla-ts/package.json +14 -0
  132. package/template-vanilla-ts/resources.ts +52 -0
  133. package/template-vanilla-ts/schema.graphql +7 -0
  134. package/template-vanilla-ts/tsconfig.json +10 -0
  135. package/template-vanilla-ts/web/index.html +28 -0
  136. package/template-vanilla-ts/web/index.js +18 -0
  137. package/template-vanilla-ts/web/styles.css +57 -0
package/template-vanilla-ts/config.yaml ADDED
@@ -0,0 +1,24 @@
1
+ # yaml-language-server: $schema=./node_modules/harperdb/config-app.schema.json
2
+
3
+ # This is the configuration file for the application.
4
+ # It specifies built-in Harper components that will load the specified feature and files.
5
+ # For more information, see https://docs.harperdb.io/docs/reference/components/built-in-extensions
6
+
7
+ # Load Environment Variables from the specified file
8
+ # loadEnv:
9
+ # files: '.env'
10
+
11
+ # This provides the HTTP REST interface for all exported resources
12
+ rest: true
13
+
14
+ # These reads GraphQL schemas to define the schema of database/tables/attributes.
15
+ graphqlSchema:
16
+ files: 'schema.graphql'
17
+
18
+ # Loads JavaScript modules such that their exports are exported as resources
19
+ jsResource:
20
+ files: 'resources.ts'
21
+
22
+ # Serve the static files from the web directory as a web application
23
+ static:
24
+ files: 'web/*'
package/template-vanilla-ts/graphql.config.yml ADDED
@@ -0,0 +1,3 @@
1
+ schema: schema.graphql
2
+ include: node_modules/harperdb/schema.graphql
3
+ documents: '**/*.graphql'
package/template-vanilla-ts/package.json ADDED
@@ -0,0 +1,14 @@
1
+ {
2
+ "name": "your-package-name-here",
3
+ "version": "1.0.0",
4
+ "description": "Your new Harper app",
5
+ "type": "module",
6
+ "scripts": {
7
+ "start": "harperdb run .",
8
+ "dev": "harperdb dev .",
9
+ "deploy": "npx -y dotenv-cli -- harperdb deploy . restart=rolling replicated=true"
10
+ },
11
+ "devDependencies": {
12
+ "harperdb": "^4.7.15"
13
+ }
14
+ }
package/template-vanilla-ts/resources.ts ADDED
@@ -0,0 +1,52 @@
1
+ import { type RecordObject, type RequestTargetOrId, Resource } from 'harperdb';
2
+
3
+ /** Here we can define any JavaScript-based resources and extensions to tables
4
+ import { tables, type RequestTarget } from 'harperdb';
5
+
6
+ interface TableNameRecord {
7
+ id: string;
8
+ name: string;
9
+ tag: string;
10
+ }
11
+
12
+ export class TableName extends tables.TableName<TableNameRecord> {
13
+ // we can define our own custom POST handler
14
+ async post(target: RequestTargetOrId, newRecord: Omit<TableNameRecord, 'id'>) {
15
+ // do something with the incoming content;
16
+ return super.post(target, newRecord);
17
+ }
18
+ // or custom GET handler
19
+ async get(target: RequestTarget): Promise<TableNameRecord> {
20
+ // we can modify this resource before returning
21
+ return super.get(target);
22
+ }
23
+ }
24
+ */
25
+
26
+ interface GreetingRecord {
27
+ greeting: string;
28
+ }
29
+
30
+ export class Greeting extends Resource<GreetingRecord> {
31
+ static loadAsInstance = false;
32
+
33
+ async post(target: RequestTargetOrId, newRecord: Partial<GreetingRecord & RecordObject>): Promise<GreetingRecord> {
34
+ return { greeting: 'Greetings, post!' };
35
+ }
36
+
37
+ async get(target?: RequestTargetOrId): Promise<GreetingRecord> {
38
+ return { greeting: 'Greetings, get!' };
39
+ }
40
+
41
+ async put(target: RequestTargetOrId, record: GreetingRecord & RecordObject): Promise<GreetingRecord> {
42
+ return { greeting: 'Greetings, put!' };
43
+ }
44
+
45
+ async patch(target: RequestTargetOrId, record: Partial<GreetingRecord & RecordObject>): Promise<GreetingRecord> {
46
+ return { greeting: 'Greetings, patch!' };
47
+ }
48
+
49
+ async delete(target: RequestTargetOrId): Promise<boolean> {
50
+ return true;
51
+ }
52
+ }
package/template-vanilla-ts/schema.graphql ADDED
@@ -0,0 +1,7 @@
1
+ ## Here we can define any tables in our database. This example shows how we define a type as a table using
2
+ ## the type name as the table name and specifying it is an "export" available in the REST and other external protocols.
3
+ type TableName @table @export {
4
+ id: ID @primaryKey # Here we define primary key (must be one)
5
+ name: String # we can define any other attributes here
6
+ tag: String @indexed # we can specify any attributes that should be indexed
7
+ }
package/template-vanilla-ts/tsconfig.json ADDED
@@ -0,0 +1,10 @@
1
+ {
2
+ "compilerOptions": {
3
+ "allowImportingTsExtensions": true,
4
+ "lib": [
5
+ "es2015",
6
+ "dom",
7
+ "es2018.asynciterable"
8
+ ]
9
+ }
10
+ }
package/template-vanilla-ts/web/index.html ADDED
@@ -0,0 +1,28 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
6
+ <title>your-project-name-here</title>
7
+ <link rel="stylesheet" href="styles.css" />
8
+ </head>
9
+ <body>
10
+ <main>
11
+ <h1>your-project-name-here</h1>
12
+ <p>
13
+ This is an example of serving static assets using the built-in
14
+ <a
15
+ href="https://docs.harperdb.io/docs/reference/components/built-in-extensions#static"
16
+ >static component</a>. <br />
17
+ You can use this component to serve web applications!
18
+ </p>
19
+ <div>
20
+ <p class="count" id="count">0</p>
21
+ <button class="decrement" id="decrement">-</button>
22
+ <button class="increment" id="increment">+</button>
23
+ </div>
24
+ </main>
25
+
26
+ <script src="index.js"></script>
27
+ </body>
28
+ </html>
package/template-vanilla-ts/web/index.js ADDED
@@ -0,0 +1,18 @@
1
+ let count = 0;
2
+ const counterDisplay = document.getElementById('count');
3
+ const decrementButton = document.getElementById('decrement');
4
+ const incrementButton = document.getElementById('increment');
5
+
6
+ function updateDisplay() {
7
+ counterDisplay.textContent = count;
8
+ }
9
+
10
+ decrementButton.addEventListener('click', () => {
11
+ count--;
12
+ updateDisplay();
13
+ });
14
+
15
+ incrementButton.addEventListener('click', () => {
16
+ count++;
17
+ updateDisplay();
18
+ });
package/template-vanilla-ts/web/styles.css ADDED
@@ -0,0 +1,57 @@
1
+ body {
2
+ font-family: Arial, sans-serif;
3
+ display: flex;
4
+ justify-content: center;
5
+ align-items: center;
6
+ height: 100vh;
7
+ margin: 0;
8
+ background-color: #f5f5f5;
9
+ }
10
+
11
+ main {
12
+ text-align: center;
13
+ background-color: white;
14
+ padding: 2rem;
15
+ border-radius: 8px;
16
+ box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
17
+ }
18
+
19
+ .count {
20
+ font-size: 4rem;
21
+ margin: 1rem 0;
22
+ color: #333;
23
+ }
24
+
25
+ .counter-controls {
26
+ display: flex;
27
+ justify-content: center;
28
+ gap: 1rem;
29
+ }
30
+
31
+ button {
32
+ font-size: 1.5rem;
33
+ width: 3rem;
34
+ height: 3rem;
35
+ border: none;
36
+ border-radius: 50%;
37
+ cursor: pointer;
38
+ transition: background-color 0.2s;
39
+ }
40
+
41
+ .decrement {
42
+ background-color: #ff6b6b;
43
+ color: white;
44
+ }
45
+
46
+ .decrement:hover {
47
+ background-color: #ff5252;
48
+ }
49
+
50
+ .increment {
51
+ background-color: #4ecdc4;
52
+ color: white;
53
+ }
54
+
55
+ .increment:hover {
56
+ background-color: #39b2a9;
57
+ }