https://github.com/unimal-jp/spear

The spear OSS repository
https://github.com/unimal-jp/spear

cms ssg

Last synced: 3 days ago
JSON representation

The spear OSS repository

• Host: GitHub
• URL: https://github.com/unimal-jp/spear
• Owner: unimal-jp
• License: mit
• Created: 2022-06-27T05:14:05.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-23T09:26:49.000Z (9 months ago)
• Last Synced: 2025-02-08T04:02:40.171Z (6 days ago)
• Topics: cms, ssg
• Language: TypeScript
• Homepage: https://late-cloud-6411.spearly.app
• Size: 1.93 MB
• Stars: 10
• Watchers: 7
• Forks: 1
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[日本語](./README_ja.md)

# Spear

This is Open Source Repository for Spear🚀

## What is Spear?

The Spear is Static Site Generator(SSG) that can integrate with Headless CMS called Spearly.

You can build the static site without Spearly as well.

The Spear project has the following packages:

| Packages | Status | Details | README Link |

|---|---|---|---|

| [`spear-cli`](./packages/spear-cli/) | [![npm version](https://badge.fury.io/js/spear-cli.svg)](https://badge.fury.io/js/spear-cli) | SSG CLI | [README](./packages/spear-cli/README.md) |

| [`create-spear`](./packages/create-spear/) | [![npm version](https://badge.fury.io/js/create-spear.svg)](https://badge.fury.io/js/create-spear) | Spear Project creation tool | [README](./packages/create-spear/README.md) |

| [`cms-js-core`](./packages/spearly-cms-js-core/) | Public | Spearly contents converter library. | [README](./packages/spearly-cms-js-core/README.md) |

| `spearly-flutter` | In Planning | The library which Embedding CMS Content into Flutter | - |

| `spearly-svelte` | In Planning | The library which embedding CMS Content into Svelte Kit | - |

| `spearly-astro` | In Planning | The plugin which embedding Spearly Content into Astro more easily | - |

---

## SSG Usage

1. Create project

You can create the project by using `npm create spear@latest `create` command to answer some questions.

```bash

$ npm create spear@latest

Namespace(port=undefined, action='create', projectName=undefined, src=undefined)

 ### Welcome to Spear CLI ###

? Name of your project test-project

? Use Spearly CMS Yes

? Choose template type basic

? Enter your Spearly CMS API KEY abc

  ## Your project was created 🎉

  To start using, run the following command:

      cd test-project

      yarn install

  To start local server, run

      yarn dev

  To build static sources, run

      yarn build

```

2. Install related packages and build the project

You can build the project for `build` task. (You can switch debug mode by using `dev` task as well)

```bash

$ cd test-project

# If you use the npm.

$ npm install

$ npm run build

# If you use the yarn.

$ yarn install

$ yarn build

# If you use the pnpm.

$ pnpm install

$ pnpm run build

```

---

## Resource

- [Spearly CMS Official Documentation](https://docs.spearly.com)

## Contributors

Thank you for your participation!



  



## Contributing

The Spear project is open source, so we waiting for your contribution🚀

If you want to contribute to this project, You can read [CONTRIBUTING.md](./CONTRIBUTING.md) !  

We look forward to your participation in the following:

- Use our library and feedback!

- File the issue to https://github.com/unimal-jp/spear/issues/

- Implement the planning feature in the issue.