@shivaedev/create-app 0.0.0-stage → 0.1.0
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.
- package/CHANGELOG.md +7 -0
- package/LICENSE +21 -0
- package/README.md +35 -2
- package/dist/CreateAppError.d.ts +11 -0
- package/dist/CreateAppError.d.ts.map +1 -0
- package/dist/CreateAppError.js +5 -0
- package/dist/CreateAppError.js.map +1 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +101 -0
- package/dist/createApp.d.ts +5 -0
- package/dist/createApp.d.ts.map +1 -0
- package/dist/createApp.js +38 -0
- package/dist/createApp.js.map +1 -0
- package/dist/pack.d.ts +2 -0
- package/dist/pack.d.ts.map +1 -0
- package/dist/pack.js +6 -0
- package/dist/pack.js.map +1 -0
- package/dist/packTemplate.d.ts +4 -0
- package/dist/packTemplate.d.ts.map +1 -0
- package/dist/packTemplate.js +39 -0
- package/dist/packTemplate.js.map +1 -0
- package/dist/template.d.ts +17 -0
- package/dist/template.d.ts.map +1 -0
- package/dist/template.js +53 -0
- package/dist/template.js.map +1 -0
- package/docs/north-star.md +7 -0
- package/docs/roadmap.md +16 -0
- package/package.json +60 -3
- package/src/CreateAppError.ts +5 -0
- package/src/cli.ts +23 -0
- package/src/createApp.ts +41 -0
- package/src/pack.ts +11 -0
- package/src/packTemplate.ts +42 -0
- package/src/template.ts +63 -0
- package/template.json +1 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ShivaeDev
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,36 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @shivaedev/create-app
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Start a Platform application without copying repository files or editing workspace dependencies. One command creates the maintained starter, installs its published dependencies and shows the steps to run it.
|
|
4
|
+
|
|
5
|
+
## From an empty folder to an app
|
|
6
|
+
|
|
7
|
+
The starter brings PostgreSQL, authenticated RPC and a React notes screen together in a small application you can change. Its source stays in Platform's `examples/starter`, so the generator carries the same app that the framework maintains.
|
|
8
|
+
|
|
9
|
+
```text
|
|
10
|
+
Created my-app.
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Create and run
|
|
14
|
+
|
|
15
|
+
Use Node 24 or newer and pnpm. The package contains a snapshot of the starter made when it is packed. Platform dependencies use exact versions from the starter's `published-versions.json`; its self-contained pnpm catalog pins the remaining dependencies.
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
pnpm create @shivaedev/app my-app
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The folder argument may include a parent path. Its final folder name becomes the package name and must be a lowercase npm name. The destination must be absent or empty, including hidden files. The command runs `pnpm install` in the generated app and reports an installation failure with a nonzero exit status.
|
|
22
|
+
|
|
23
|
+
After installation, follow the printed steps:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
cd my-app
|
|
27
|
+
cp .env.example .env.local
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Set `DATABASE_URL` to your PostgreSQL database and `BETTER_AUTH_SECRET` to a random secret of at least 32 characters, then run:
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
pnpm dev
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The command also supports `--help` and `--version`. It creates files and installs dependencies; it does not create your database or set secrets. See the [framework quickstart](https://github.com/ShivaeDev/platform/blob/main/docs/framework/quickstart.md) for the starter's application and deployment workflow.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Runtime } from "effect";
|
|
2
|
+
declare const CreateAppError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
|
|
3
|
+
readonly _tag: "CreateAppError";
|
|
4
|
+
} & Readonly<A>;
|
|
5
|
+
export declare class CreateAppError extends CreateAppError_base<{
|
|
6
|
+
readonly message: string;
|
|
7
|
+
}> {
|
|
8
|
+
readonly [Runtime.errorReported] = false;
|
|
9
|
+
}
|
|
10
|
+
export {};
|
|
11
|
+
//# sourceMappingURL=CreateAppError.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"CreateAppError.d.ts","sourceRoot":"","sources":["../src/CreateAppError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,OAAO,EAAE,MAAM,QAAQ,CAAC;;;;AAEvC,qBAAa,cAAe,SAAQ,oBAAmC;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;IACnG,SAAkB,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS;CAClD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"CreateAppError.js","sourceRoot":"","sources":["../src/CreateAppError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEvC,MAAM,OAAO,cAAe,SAAQ,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAA+B;IACjF,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;CAClD"}
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
|