Skip to content
Our family blog, documenting our work in Ukraine.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
bin
components
layouts
middleware
mixins
pages
plugins
static
store
.editorconfig
.eslintrc.js
.gitignore
.stylelintrc
.tool-versions
LICENSE
README.md
nuxt.config.js
package.json
postcss.config.js
robots-dev.txt
robots-prod.txt
tailwind.js
yarn.lock

README.md

ofreport.com


OFReport.com

OFReport.com is our family blog, documenting our ministry in Ukraine.

🚧 Under Development

This branch is a complete rewrite of OFReport.com using Nuxt.js and is currently under development. The Middleman version of the site (currently used in production) is now under the mm-ruby branch.

Requirements

Setup

To get started, clone/fork the repo, cd into it, and install the dependencies.

$ yarn install

Static Build

In addition to deploying server-rendered apps, Nuxt also works great as a static site generator. That's how we're using it here. To pre-render the entire site as static HTML, CSS, and JavaScript files, run this command:

$ yarn generate

The generated site will be output to the dist/ folder.

Local HTTP Server

Sometimes in development it can be helpful to run the statically generated site with a local web server, simulating a production environment. I have found http-server to be a great choice. Here's how I build and serve the static site on my local machine.

First, install http-server globally if you don't already have it.

$ npm install http-server -g

Next, build the site as explained in the previous section.

$ yarn generate

Finally, move into the dist/ folder and start the server.

$ cd dist/
$ http-server -p 8080

Visit http://localhost:8080 and check out the site!

Code Style and Linting

Project-specific JavaScript conforms to the Standard code style.

JavaScript Style Guide

JS linting is done with ESLint and extended with eslint-plugin-vue and eslint-plugin-standard.

CSS linting is done with stylelint.

I use Neovim as my editor along with the ALE plugin for asynchronous linting.

Legal

© 2019 Joshua and Kelsie Steele. Software is licensed under MIT.

You can’t perform that action at this time.