Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gavinmcfarland/stancy
A simple API for delivering content from static files and folders.
https://github.com/gavinmcfarland/stancy
api file-based-cms flat-file headless-cms rest-like static
Last synced: about 2 months ago
JSON representation
A simple API for delivering content from static files and folders.
- Host: GitHub
- URL: https://github.com/gavinmcfarland/stancy
- Owner: gavinmcfarland
- License: cc0-1.0
- Created: 2020-04-07T16:27:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T12:23:48.000Z (6 months ago)
- Last Synced: 2024-10-30T00:36:36.607Z (2 months ago)
- Topics: api, file-based-cms, flat-file, headless-cms, rest-like, static
- Language: JavaScript
- Homepage: https://stancy.vercel.app/
- Size: 18.8 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Stancy
Stancy uses static files and folders to generate a database of collections and items. The database can be queried as a plain object, outputted as a json file, or served using an express server for a RESTlike API. This is useful for building static sites which use frameworks like React, Vue, Svelte or Marko. Stancy is unbiased about how you use it and can be customised to suit different use-cases.
- [Example](#example)
- [Installation](#installation)
- [Features](#features)
- [Docs](#docs)
- [Development](#development)
## Example
In this example, we'll look at how we can create a database from static files and folders which can be accessed using an API for a website.
Start by creating a folder with some content, below is an example. Each top level file or folder creates a root endpoint.
```bash
content/
site.json
pages/
home.md
about.md
services.md
```
Here we've created a file `site.json` which stores key information about our site, some `pages`, and a `blog`.
Now start the server.
```js
stancy('content/').server(3000, '/api/')
```
We can access the content using the following requests:
- [localhost:3000/api/site](http://localhost:3000/api/site)
- [localhost:3000/api/pages](http://localhost:3000/api/pages)
- [localhost:3000/api/pages/about](http://localhost:3000/api/pages/about)
Check out the [examples](/examples).
## Installation
Add the npm package to your project.
```bash
npm install stancy
```
## Features
- ### Server and client
Easily serve content from static folders and files, and fetch content.
---
- ### Collections and Items
Collections are created by plural sounding folders. Items are created using files and non-plural sounding folders.
---
- ### Preprocess data
Easily sort collections, format dates, and parse content on the client.
---
- ### Index File
This is useful if you prefer to organise using folders or if you want to create an index page for a group of related content.
```bash
# Creates a collection of items
posts/
item-one.md
item-two.md
item-three.md
# Creates an item
item/
index.md
```
---
- ### Hidden
Prepend an underscore to hide a file or folder. In the case of hiding a folder, this will also hide all it's contents.
```
_file-is-hidden.md
_folder-is-hidden/
```
---
- ### File Types (Planned)
The following file types are supported.
- Archives
- Audio
- Code
- Documents
- Images
- Videos
---
- ### Meta Data (Planned)
You can add meta data to images by creating a data file with a matching name.
```
my-first-post/
playing-frisbee.jpg
playing-frisbee.yml
```
This will create the following image meta data
```jsonc
{
// ...
"images": [
{
"src": "/static/playing-frisbee.jpg",
"alt": "Me playing frisbee"
}
]
}
```
---
- ### Built in Fields
If you create a database you can filter and show data using a query language of your choice using the following field names.
#### Private
- `_name` Name of the resource
- `_collection` Collection the resource belongs to
- `_index` The index of the resource in the collection or dataset
- `_type` The type of resource. Named after the folder or file.
- `_source` The path to the folder containing the file.
#### Public
- `url` The url to the resource.
## Docs
- ### Starting a server
`stancy(source).server([port, path])`
#### Arguments
- __`source`__ { String } source of the content directory to be servered
- __`port`__ { Number }
- __`path`__ { String } subpath where API will be accessible from
#### Example
```js
stancy('content/').server(3000, '/api/')
```
---
- ### Starting a client
`stancy([source]).client(url)`
#### Arguments
- __`url`__ { String } url of the production server
#### Example
```js
stancy('content/').client('http://domain.com/api/')
```
---
- ### Preprocessing data
`client.preprocess([type,] callback)`
Useful for sorting collections, formatting dates, or parsing markdown.
#### Arguments
- __`type`__ { String } can be one of the following:
- __`collection`__ returns every collection as an array of objects.
- __`item`__ returns every item as an object with key value pairs.
- __`content`__ returns value of every item with a property of _content_.
- __`callback`__ { function } gives access to one of the types of `data` above.
#### Examples
An example of sorting collections by date
```js
client.preprocess('collection', (data) => {
return data.sort((a, b) => {
if (a.date > b.date) {
return 1;
} else if (a.date < b.date) {
return -1
} else {
return 0
}
})
})
```
An example of formatting machine readable dates
```js
client.preprocess('item', (data) => {
return data.date = new Date(data.date)
})
```
An example of parsing markdown
```js
client.preprocess('content', (data) => {
return marked(data)
})
```
---
- ### Getting data
```js
client.get('users/jerry').then(res => {
console.log(res)
}).catch(err => {
console.log(err)
})
```
Example response
```json
{
"url": "users/jerry",
"name": "Jerry",
"age": "24",
"role": "admin",
"content": "
Jerry
"
}
```
---
- ### Creating a database
`stancy(source).database()`
#### Example
```js
var database = stancy('content/').database()
```
---
- ### Configure using config file (Planned)
__stancy.config.js__
```js
{
source: 'content/',
client: {
production: 'https://stancy.now.sh/api/',
token: 'T89ALS90',
preprocess: ({content}) => {
content = marked(content)
}
}
}
```
#### Specify custom config file
```js
stancy().config('src/stancy.config.js')
```
## Development
To install the dependencies
```
npm install
```
To run the demo server
```
npm run demo
```
To run tests
```
npm run test
```