update to reflect new package
This commit is contained in:
parent
cddb8a89e0
commit
bddafa4536
|
@ -0,0 +1,52 @@
|
|||
name: Publish Create-Astro-GhostCMS
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
publishnpm:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./packages/create-astro-ghostcms
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 18
|
||||
registry-url: https://registry.npmjs.org/
|
||||
- name: publish-npm
|
||||
run: |
|
||||
# Change publish registry
|
||||
echo "$(jq '.publishConfig.registry = "https://registry.npmjs.org"' package.json)" > package.json
|
||||
# Publish package
|
||||
npm publish
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
||||
|
||||
githubpackage:
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./packages/create-astro-ghostcms
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 18
|
||||
registry-url: https://npm.pkg.github.com
|
||||
- name: publish-github
|
||||
run: |
|
||||
# Change publish registry
|
||||
echo "$(jq '.publishConfig.registry = "https://npm.pkg.github.com"' package.json)" > package.json
|
||||
# Publish package
|
||||
npm publish
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{secrets.ACTION_TOKEN}}
|
11
README.md
11
README.md
|
@ -2,6 +2,17 @@
|
|||
|
||||
# Welcome to Astro-GhostCMS
|
||||
|
||||
## 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**:
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@matthiesenxyz/create-astro-ghostcms",
|
||||
"version": "0.0.1-dev42",
|
||||
"version": "0.0.1",
|
||||
"description": "Utility to quickly get started with our Integration and astro",
|
||||
"type": "module",
|
||||
"main": "./create-astro-ghostcms.mjs",
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
# First Create a fresh Astro Install
|
||||
npm create astro@latest
|
||||
# Create Empty Install with standard typescript
|
||||
# Then Delete entire 'pages' folder under '/src/'
|
||||
npx astro add @matthiesenxyz/astro-ghostcms
|
||||
# Then Create the following environment variables in .env
|
||||
# Tip: Set these to YOUR GhostCMS server to pull your content!
|
||||
CONTENT_API_KEY=a33da3965a3a9fb2c6b3f63b48
|
||||
CONTENT_API_URL=https://ghostdemo.matthiesen.xyz
|
||||
# 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)
|
|
@ -6,7 +6,16 @@ description: Integration Mode - Manual Install
|
|||
## Install
|
||||
|
||||
```sh
|
||||
npm i @matthiesenxyz/astro-ghostcms @matthiesenxyz/astro-ghostcms-theme-default
|
||||
# For fresh Install
|
||||
npm create astro@latest
|
||||
# Create Empty Install with standard typescript
|
||||
# Then Delete entire `pages` folder under `/src/`
|
||||
|
||||
# Then run one of the following:
|
||||
# Astro Quick mode
|
||||
npx astro add @matthiesenxyz/astro-ghostcms
|
||||
# Manual Method
|
||||
npm i @matthiesenxyz/astro-ghostcms
|
||||
```
|
||||
|
||||
Then set your `astro.config.ts` to look like this:
|
||||
|
|
|
@ -3,24 +3,20 @@ title: Integration Mode - Quick Install
|
|||
description: Integration Mode - Quick Install
|
||||
---
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
# For fresh Install
|
||||
npm create astro@latest
|
||||
# Create Empty Install with standard typescript
|
||||
# Then Delete entire `pages` folder under `/src/`
|
||||
npx astro add @matthiesenxyz/astro-ghostcms
|
||||
```sh title="Simple"
|
||||
# Run this command and follow the prompt!
|
||||
npx astro add @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)
|
||||
```
|
||||
|
||||
## Setup `.env` variables
|
||||
|
||||
```ansi frame="code" title=".env"
|
||||
[1;31mCONTENT_API_KEY[0m=[33ma33da3965a3a9fb2c6b3f63b48
|
||||
[1;31mCONTENT_API_URL[0m=[33mhttps://ghostdemo.matthiesen.xyz
|
||||
```sh title="Advanced"
|
||||
npx astro add @matthiesenxyz/create-astro-ghostcms <template> <project_directory> --git --install
|
||||
```
|
||||
|
||||
***When you deploy your install dont forget to set the above ENVIRONMENT VARIABLES!***
|
||||
***When you deploy your install dont forget to set your ENVIRONMENT VARIABLES!***
|
||||
|
||||
## Created Routes
|
||||
|
||||
|
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: 'New create-astro-ghostcms CLI Utility'
|
||||
date: '01-28-2024'
|
||||
versionNumber: 'POST'
|
||||
description: 'New create-astro-ghostcms CLI Utility'
|
||||
#image:
|
||||
# src: '../../assets/starlog-placeholder-2.jpg'
|
||||
# alt: 'The full Astro logo.'
|
||||
---
|
||||
|
||||
## We now have a CLI Utility to quickly deploy new projects!
|
||||
|
||||
Wow, after many hours of tinkering and trying to figure this out I have finally completed `@matthiesenxyz/create-astro-ghostcms` a `clack` based CLI Utility to auto install our project with default variables set.
|
Loading…
Reference in New Issue