diff --git a/.github/assets/create-astro-ghostcms-2024.jan.27.png b/.github/assets/create-astro-ghostcms-2024.jan.27.png new file mode 100644 index 00000000..d60bdac6 Binary files /dev/null and b/.github/assets/create-astro-ghostcms-2024.jan.27.png differ diff --git a/README.md b/README.md index 123c3697..15c8e704 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,10 @@ In this Repo you will also find the Following: - `www`: [Public Site](https://astro-ghostcms.xyz) - `playground`: Development and Testing - `packages/`: + - `create-astro-ghostcms`: CLI Utility to quickly deploy new Astro-GhostCMS projects. - `astro-ghostcms`: The main Integration! - - `astro-ghostcms-theme-default`: The Default theme in integration mode - - `tsconfig`: *LOCAL* Development package for `@ts-ghost/core-api` + - `astro-ghostcms-theme-default`: The Default theme in integration mode. + - `tsconfig`: *LOCAL* Development package for `@ts-ghost/core-api`. ### Notices diff --git a/package.json b/package.json index 5ffbe2a4..e8428802 100644 --- a/package.json +++ b/package.json @@ -6,12 +6,11 @@ "node": ">=18.19.0" }, "scripts": { + "lint": "biome check .", + "lint:fix": "biome check --apply .", "playground:dev": "pnpm --filter playground dev", "www:dev": "pnpm --filter www dev", "demo:dev": "pnpm --filter demo dev", - "lint": "biome check .", - "lint:fix": "biome check --apply .", - "base": "pnpm i --frozen-lockfile", "api:test": "pnpm --filter astro-ghostcms test", "api:test:watch": "pnpm --filter astro-ghostcms test:watch", "api:test:coverage": "pnpm --filter astro-ghostcms test:coverage", diff --git a/packages/create-astro-ghostcms/LICENSE b/packages/create-astro-ghostcms/LICENSE new file mode 100644 index 00000000..848a13f2 --- /dev/null +++ b/packages/create-astro-ghostcms/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Adam Matthiesen + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/create-astro-ghostcms/README.md b/packages/create-astro-ghostcms/README.md new file mode 100644 index 00000000..7ddfa4b3 --- /dev/null +++ b/packages/create-astro-ghostcms/README.md @@ -0,0 +1,33 @@ +# `@matthiesenxyz/create-astro-ghostcms` + +Utility to quickly get started with our Integration and astro. + +![Demo](./src/assets/create-astro-ghostcms.png) + +The Default install method requires `pnpm` if you dont have `pnpm` installed you can change this by using the command below with the following argument `--pkg-manager ` with the Package manager of your choice(i.e npm, yarn). + +```sh +npx @matthiesenxyz/create-astro-ghostcms + +# OR + +npx @matthiesenxyz/create-astro-ghostcms