CPany Template Data Repo

更新时间：2022-01-18 15:09

Getting Started

Use CPany template @cpanyjs/template to create your own repository for data storage.

Update config file cpany.yml, and push the changes to Github. Then, Github Actions will automatically fetch data and push to your repository.

You can use Netlify, Vercel, Github Pages, etc. to deploy generated static site.

Netlify Deploy

The template repository has provided Netlify config file netlify.toml with the following content.

[build.environment]
  NODE_VERSION = "14"

[build]
  publish = "dist"
  command = "npm run build"

[[redirects]]
  from = "/*"
  to = "/index.html"
  status = 200

Then you can just create a new CPany site with your repository on Netlify.

Vercel Deploy

The template repository has provided Vercel config file Vercel.json with the following content.

{
  "rewrites": [
    { "source": "/(.*)", "destination": "/index.html" }
  ]
}

Then you can just create a new CPany site with your repository on Vercel.

Github Pages Deploy

The template repository has also provided a workflow gh-pages.yml, which will automatically push the generated static site to the branch gh-pages. You can just enable Github Pages in the Settings of your repository.

Upgrading

The template repo provides an automating upgrading action upgrade.yml. You can manually run it in the actions tab - Upgrade CPany.

License

MIT License © 2021 XLor