Light

eggplanetio / gustavo Goto Github PK

View Code? Open in Web Editor NEW

134.0 5.0 10.0 584 KB

👨 A (mostly) headless blogging platform built atop Nuxt & Gist.

JavaScript 38.95% CSS 18.85% Vue 41.06% Shell 1.14%

blog vue vue2 nuxt gist gus

gustavo's Introduction

A (mostly) headless blogging platform built atop Nuxt & Gist.

Contents

Overview
Creating content
Getting started
Deployment

Overview

Gustavo is an opinionated, (mostly) headless blogging platform built to use:

Github Gist
Nuxt (Vue 2.x)
Docker

Using a simple naming schema, Gustavo can create a whole blog for you in seconds. Don't believe me? Check out the gist that is my blog.

Creating content

You can create content for your blog by simply creating files in a gist that follow this schema:

Type	Naming	Example
post	`{name}.post.md`	link
page	`{name}.page.md`	link
navigation	`links.md`	link
navigation	`links.txt` (deprecated)	link
image	clone gist and upload	link
draft	`{name}.post.draft.md`

Here is the gist that powers this blog.

Getting started

To create a blog, follow these steps:

Create your gist and add some content.
Create gustavo.config.js with the following:

module.exports = {
  title: 'My gustavo blog',
  gistId: '<< gist id >>',
  githubToken: '<< token >>', /* optional, recommended */
  googleAnalyticsId: 'UA-X-XXXXX'
}

Note: you'll want to create a personal access token on Github because Gustavo uses the Gist API, and without the token and although it will still work, your blog will be rate limited.

Create a Dockerfile with the following:

FROM eggplanet/gustavo:latest

Let's start it up:

$ docker build -t my-gustavo-blog .
$ docker run -p 3000:3000 my-gustavo-blog

Your blog will be running at http://localhost:3000

Deployment

Deploying gustavo is simple. The recommended method is Now by Zeit.

$ now secrets add gustavo-github-token <TOKEN>
$ now secrets add gustavo-gist-id <ID>
$ now -e GITHUB_TOKEN=@gustavo-github-token -e GIST_ID=@gustavo-gist-id --docker
$ now alias my-gustavo-blog-wjdihnxorf.now.sh my-gustavo.blog

License

MIT

Credits

Logo

Releasing a new image

$ docker build -t eggplanet/gustavo:latest .
$ docker push eggplanet/gustavo:latest

Changelog

2.0.0

Better caching using apicache
Cleaned up a bunch of dead code
nuxt@^1.0.0-rc11

1.0.0

Initial release

gustavo's People

Contributors

Stargazers

Watchers

Forkers

cuulee empia lex111 rubythonode kodekoder pi0 ayopom gurugeek

gustavo's Issues

Can't get site running locally when following readme 😑

/app/node_modules/express/lib/application.js:210
    throw new TypeError('app.use() requires middleware functions');
    ^

TypeError: app.use() requires middleware functions
    at Function.use (/app/node_modules/express/lib/application.js:210:11)
    at Object.<anonymous> (/app/server.js:16:5)
    at Module._compile (module.js:571:32)
    at Object.Module._extensions..js (module.js:580:10)
    at Module.load (module.js:488:32)
    at tryModuleLoad (module.js:447:12)
    at Function.Module._load (module.js:439:3)
    at Module.runMain (module.js:605:10)
    at run (bootstrap_node.js:425:7)
    at startup (bootstrap_node.js:146:9)
    at bootstrap_node.js:540:3

Google Analytics

How do I get started using Gustavo?

From the readme, I can't figure out how to get started using Gustavo?

Do I npm i gustavo?
Or, do I git clone https://github.com/eggplanetio/gustavo.git?
Or, do I follow nuxt start up from scratch steps?

...I'm happy to help document/support more once I get the initial step. 😃

Head metadata support for posts and pages

Support for meta tags on posts

Support for syntax highlighting

executable file not found in $PATH"

When I run:

docker run [my blog] --port 3000:3000

I get the following error:

... starting container process caused "exec: \"--port\": executable file not found in $PATH"
docker: Error response from daemon: oci runtime error: container_linux.go:247: starting container process caused "exec: \"--port\": executable file not found in $PATH".

What did I do wrong? 😬

Caching for `/api/content`

Multi-Gist support

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.