astro-ghostcms/README.md

<img src="https://ghostdemo.matthiesen.xyz/content/images/size/w256h256/2024/01/spaceghost.png" width="64px" />

# Welcome to Astro-GhostCMS

Want to Chat?  Join our [Discord](https://discord.gg/u7NZqUyeAR)

## Quick Start

```sh
# Run this command and follow the prompt!
npx @matthiesenxyz/create-astro-ghostcms
# Want to pass arguments through to the command?  YOU CAN!
#  `--install`     : Sets Install Dependencies to 'true'
#  `--git`         : Initiates git Repo
#  `--pkg-manager` : Specify your Package manager(i.e. npm, yarn | DEFAULT: pnpm)
```

For a full always up to date documentation please checkout [Our Website](https://astro-ghostcms.xyz)

**Demo site Deploy status**:

![Vercel](https://vercelbadge.vercel.app/api/matthiesenxyz/astro-ghostcms)

## Repo Structure

This repo is structured as a monorepo.  All of our astro-ghostcms packages can be found under the `packages` folder.  These are all independently published or internal packages that can be found on [npmjs.com](https://npmjs.com)

In this Repo you will also find the Following:

- `demo`: [Demo Site](https://demo.astro-ghostcms.xyz)
- `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`.

## Contributing

This is a `pnpm` workspace and requires `pnpm` to function properly

To setup this workspace clone this repo and run the following command:

```sh
pnpm install
```

Then you can run the playground:

```sh
pnpm playground:dev
```

### Notices

*Ghost is a trademark of [The Ghost Foundation](https://ghost.org/trademark/). This project is not directly related to or provided by The Ghost Foundation and is intended to help create a easier method to utilize their provided JavaScript tools to link a Headless GhostCMS install in to your Astro project.*
Update README.md 2024-01-30 17:54:26 +00:00			`<img src="https://ghostdemo.matthiesen.xyz/content/images/size/w256h256/2024/01/spaceghost.png" width="64px" />`
Update README.md 2024-01-19 13:23:21 +00:00
beta.0 initial comit testing 2024-01-13 07:20:44 +00:00			`# Welcome to Astro-GhostCMS`

Update README.md 2024-01-29 11:42:24 +00:00			`Want to Chat? Join our [Discord](https://discord.gg/u7NZqUyeAR)`

update to reflect new package 2024-01-28 10:00:50 +00:00			`## Quick Start`

			```sh
			`# Run this command and follow the prompt!`
			`npx @matthiesenxyz/create-astro-ghostcms`
			`# Want to pass arguments through to the command? YOU CAN!`
			# `--install` : Sets Install Dependencies to 'true'
			# `--git` : Initiates git Repo
			# `--pkg-manager` : Specify your Package manager(i.e. npm, yarn \| DEFAULT: pnpm)
			```

update readme 2024-01-23 20:56:52 +00:00			`For a full always up to date documentation please checkout [Our Website](https://astro-ghostcms.xyz)`
update readme 2024-01-17 10:01:04 +00:00
update readme 2024-01-23 20:56:52 +00:00			`Demo site Deploy status:`
update readme 2024-01-17 10:01:04 +00:00
Update README.md 2024-01-24 02:54:51 +00:00			`![Vercel](https://vercelbadge.vercel.app/api/matthiesenxyz/astro-ghostcms)`
update readme 2024-01-17 10:18:57 +00:00
update readme 2024-01-23 20:56:52 +00:00			`## Repo Structure`
update readme 2024-01-17 10:01:04 +00:00
last commit for now 2024-01-24 02:17:54 +00:00			This repo is structured as a monorepo. All of our astro-ghostcms packages can be found under the `packages` folder. These are all independently published or internal packages that can be found on [npmjs.com](https://npmjs.com)
update readme 2024-01-17 10:01:04 +00:00
last commit for now 2024-01-24 02:17:54 +00:00			`In this Repo you will also find the Following:`

			- `demo`: [Demo Site](https://demo.astro-ghostcms.xyz)
			- `www`: [Public Site](https://astro-ghostcms.xyz)
			- `playground`: Development and Testing
			- `packages/`:
up readme 2024-01-28 04:27:23 +00:00			- `create-astro-ghostcms`: CLI Utility to quickly deploy new Astro-GhostCMS projects.
last commit for now 2024-01-24 02:17:54 +00:00			- `astro-ghostcms`: The main Integration!
up readme 2024-01-27 20:44:19 +00:00			- `astro-ghostcms-theme-default`: The Default theme in integration mode.
			- `tsconfig`: LOCAL Development package for `@ts-ghost/core-api`.
update readme 2024-01-17 10:01:04 +00:00
Update README.md 2024-01-29 10:50:26 +00:00			`## Contributing`

			This is a `pnpm` workspace and requires `pnpm` to function properly

			`To setup this workspace clone this repo and run the following command:`

			```sh
			`pnpm install`
			```

			`Then you can run the playground:`

			```sh
			`pnpm playground:dev`
			```

update readme 2024-01-23 20:56:52 +00:00			`### Notices`
Update README.md 2024-01-22 11:45:15 +00:00
update readme 2024-01-23 20:56:52 +00:00			`Ghost is a trademark of [The Ghost Foundation](https://ghost.org/trademark/). This project is not directly related to or provided by The Ghost Foundation and is intended to help create a easier method to utilize their provided JavaScript tools to link a Headless GhostCMS install in to your Astro project.`