create-kor 0.2.1 → 0.3.1
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/README.md +16 -4
- package/index.js +16 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# create-kor
|
|
2
2
|
|
|
3
|
-
Scaffold a new **
|
|
3
|
+
Scaffold a new **kör** full-stack monorepo in seconds.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
@@ -12,21 +12,33 @@ npx create-kor <project-name>
|
|
|
12
12
|
|
|
13
13
|
This will:
|
|
14
14
|
|
|
15
|
-
1. Clone the [
|
|
15
|
+
1. Clone the [kör](https://github.com/mastoj/kor) monorepo template into a new `<project-name>` directory
|
|
16
16
|
2. Set the root `package.json` name to your project name
|
|
17
17
|
3. Create `apps/web/.env.local` with a default API URL
|
|
18
18
|
4. Initialise a fresh git repository with an initial commit
|
|
19
19
|
|
|
20
20
|
## Getting started
|
|
21
21
|
|
|
22
|
+
If you have [Make](https://www.gnu.org/software/make/) installed, a single command handles everything:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
cd <project-name>
|
|
26
|
+
make kor
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Otherwise, run the steps manually:
|
|
30
|
+
|
|
22
31
|
```bash
|
|
23
32
|
cd <project-name>
|
|
24
33
|
pnpm install
|
|
34
|
+
pnpm db:push
|
|
25
35
|
pnpm dev
|
|
26
36
|
```
|
|
27
37
|
|
|
28
|
-
- **
|
|
29
|
-
- **
|
|
38
|
+
- **Home** — [http://localhost:3000](http://localhost:3000)
|
|
39
|
+
- **tRPC demo** — [http://localhost:3000/trpc-demo](http://localhost:3000/trpc-demo)
|
|
40
|
+
- **Design system** — [http://localhost:3000/design](http://localhost:3000/design)
|
|
41
|
+
- **API health** — [http://localhost:3001/health](http://localhost:3001/health)
|
|
30
42
|
|
|
31
43
|
## What's inside
|
|
32
44
|
|
package/index.js
CHANGED
|
@@ -51,7 +51,20 @@ execSync("git init && git add . && git commit -m 'Initial commit'", {
|
|
|
51
51
|
stdio: "inherit",
|
|
52
52
|
});
|
|
53
53
|
|
|
54
|
-
console.log("
|
|
54
|
+
console.log("");
|
|
55
|
+
console.log(" ~~ ~ ______________");
|
|
56
|
+
console.log(" \\ K O R \\___");
|
|
57
|
+
console.log(" ~~ ~ | o o |==>");
|
|
58
|
+
console.log(" \\____________/");
|
|
59
|
+
console.log(" (_) (_)");
|
|
60
|
+
console.log("");
|
|
61
|
+
console.log("Done! Next steps:\n");
|
|
55
62
|
console.log(` cd ${projectName}`);
|
|
56
|
-
console.log("
|
|
57
|
-
console.log("
|
|
63
|
+
console.log("");
|
|
64
|
+
console.log(" If you have Make installed:");
|
|
65
|
+
console.log(" make kor");
|
|
66
|
+
console.log("");
|
|
67
|
+
console.log(" Otherwise:");
|
|
68
|
+
console.log(" pnpm install");
|
|
69
|
+
console.log(" pnpm db:push");
|
|
70
|
+
console.log(" pnpm dev");
|