Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lachenmayer/contentbot
https://github.com/lachenmayer/contentbot
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lachenmayer/contentbot
- Owner: lachenmayer
- Created: 2018-02-24T19:21:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-17T18:42:31.000Z (almost 7 years ago)
- Last Synced: 2024-11-12T20:48:10.987Z (2 months ago)
- Language: JavaScript
- Size: 162 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Contentbot
**Under construction, use at your own risk. This repo does not respect semver (yet) - things may break at any time.**
GraphQL schema & API for creating/reading/updating/deleting pages in a static website which stores pages in a simple format on the file system, similarly to [Kirby](https://getkirby.com/docs/content/adding-content).
## Usage
### 1. Define your schema
Define a file `site.graphql` containing the types of pages that your site should support, and the custom fields that should be included on each page:
```graphql
type About {
bio: String
}
type Film {
role: String
pitch: String
description: String
youtubeUrl: String
}
```
(You will not be able to add any arguments to the fields.)
Contentbot will generate the following GraphQL schema:
```graphql
# TODO
```
For every type in `site.graphql`, it will create a set of CRUD mutations, and a corresponding input type.
### 2. Serve the schema
eg. using `graphql-yoga`:
```js
const Contentbot = require('contentbot')
const GraphQLServer = require('graphql-yoga')
const schema = `
type About {
bio: String
}
type Film {
role: String
pitch: String
description: String
youtubeUrl: String
}
`
async function main() {
const contentbot = await Contentbot('content', { schema })
const server = new GraphQLServer({ schema: contentbot })
server.start()
}
main()
```
### 3. Start querying it from your frontend!
For example, to add a new film page:
```graphql
mutation {
writeFilm(content: {url: "/film/national-youth-orchestra", title: "Meet the National Youth Orchestra of Great Britain", youtubeUrl: "https://www.youtube.com/watch?v=uv2Y4AoWA-w"}) {
url
}
}
```
You can then get the film page like this:
```graphql
query {
page(url: "/film/national-youth-orchestra") {
url
title
... on Film {
youtubeUrl
}
}
}
```
Notice that the query uses an [inline fragment](http://graphql.org/learn/queries/#inline-fragments), which is required to get the type-specific custom fields. You can also define multiple inline fragments, so you could reuse the same query for different page types, for example:
```graphql
query AnyPage($url: String!) {
page(url: $url) {
__typename
url
title
... on Film {
youtubeUrl
}
... on About {
bio
}
}
}
```
You could then check the `__typename` field, and render different templates for different types of pages.