README.md

Folk Style

An opinionated but simple style guide for technical projects authored at Analogfolk.

Build Setup

Local setup is simple enough; install dependencies and run the Nuxt project. The master branch automatically deploys to Netlify.

It's a static (nuxt generated) site. Individual guidelines are Markdown files, added to pages via @nuxt/content.

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn run dev

# build for production and launch server
$ yarn run build
$ yarn start

# generate static project
$ yarn run generate

For detailed explanation on how things work, checkout Nuxt.js docs.

TODO

• Improve .NET section
• Add section on Infrastructure as code
• Add API Design principles (REST, versioning etc.)
• Translation in to Spanish