日本語

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		SSG CLI	README
create-spear		Spear Project creation tool	README
cms-js-core	Public	Spearly contents converter library.	README
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.

$ 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)

$ 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

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 !

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.