Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/keplersj/carraway

Tool to simplify creating a Gatsby site
https://github.com/keplersj/carraway

build build-tool gatsby gatsby-site

Last synced: about 2 months ago
JSON representation

Tool to simplify creating a Gatsby site

Host: GitHub
URL: https://github.com/keplersj/carraway
Owner: keplersj
License: isc
Created: 2019-10-31T19:14:26.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-06-18T05:06:26.000Z (8 months ago)
Last Synced: 2024-11-15T03:46:03.575Z (3 months ago)
Topics: build, build-tool, gatsby, gatsby-site
Language: TypeScript
Size: 1.38 MB
Stars: 3
Watchers: 3
Forks: 2
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Carraway

Tool to simplify building a [Gatsby](https://www.gatsbyjs.org/) site. For more information see [Motivation](#motivation) and [Implementation](#implementation) below.

## Installation

```bash
# using npm:

npm install gatsby carraway

# using yarn:

yarn add gatsby carraway
```

## Usage

Create a `gatsby.config.json` file in your repos root or add a `gatsby` field to your `package.json`, with the following structure:

```json
{
"siteMetadata": {},
"plugins": []
}
```

This will act the basis for the Gatsby site Carraway builds.

### Building Site

To build your Gatsby site with Carraway, run:

```bash
carraway build
```

### Development Mode

To run your Gatsby site in development mode with Carraway, run:

```bash
carraway develop
```

### Cleaning Up

To clean up the artifacts created by Gatsby and Carraway, run:

```bash
carraway clean
```

## Motivation

While building [my website](https://github.com/keplersj/website), [the website for my surname](https://github.com/keplersj/surname-site), the [AtomLinter website](https://github.com/AtomLinter/atomlinter.github.io), and [AtomBuild website](https://github.com/AtomBuild/atombuild.github.io) I became very interested with idea of separating the content of a website from the code that renders it to a webpage.

Gatsby does a lot of the work for us by letting us isolate how data and content is handled from the React code that renders it. The framework then takes this one step further by allowing you to isolate entire website themes, and slotting in content and data.

Carraway aims to take this functionality to the next step with the goal of creating Gatsby sites with repos that contain no code, just the site's data, content, and configuration.

Sites using Carraway will still be using Gatsby, and you will have to configure it as such. However instead of configuring Gatsby in a `gatsby-config.js` at the repo's root, Carraway sites will be configured using JSON in a `gatsby.config.json` file at the repo's root or under the `gatsby` field in the repo's `package.json`.

### Why Carraway?

In _The Great Gatsby_ the reader follows the tale of narrator Nick Carraway as he recalls his summer with the titular character Jay Gatsby. Through the course of the book Nick befriends Gatsby and helps him attain a lifelong muse.

Similar to this dynamic of classic American literature, our Carraway simply hopes to make things easier for us and Gatsby.

## Implementation

Much like the character its named after, this package is rather simple.

Carraway creates a `gatsby-config.js` for Gatsby to interact with, and invokes Gatsby for you. This lets us declare our site's configuration somewhere else, while providing it to Gatsby when Gatsby needs it.

## Prior Art

- [Gatsby](https://www.gatsbyjs.org/) - powerful static-site generating framework
- [Docz](https://www.docz.site/) - builds a Gatsby site based on repo content

## License