An open API service indexing awesome lists of open source software.

https://github.com/cpanyjs/template

CPany Template Data Repo
https://github.com/cpanyjs/template

netlify static-site static-site-generator template

Last synced: 12 days ago
JSON representation

CPany Template Data Repo

Awesome Lists containing this project

README

          

# CPany Template Data Repo

[![version](https://img.shields.io/npm/v/@cpany/cli?color=rgb%2850%2C203%2C86%29&label=CPany)](https://www.npmjs.com/package/@cpany/cli)

更新时间:[2022-01-18 15:09](https://www.timeanddate.com/worldclock/fixedtime.html?msg=Fetch+data&iso=202201181642489793000150953&p1=237)

![members](./screenshot.png)

## Getting Started

Use CPany template [@cpanyjs/template](https://github.com/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.

```toml
[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.

```json
{
"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](https://github.com/yjl9903)