Skip to content

README.md

Latest commit

 

History

History
76 lines (51 loc) · 1.65 KB

README.md

File metadata and controls

76 lines (51 loc) · 1.65 KB

Code Style

GitHub package.json version (branch) Netlify code style: prettier GitHub

An opinionated but simple style guide for engineering projects.

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.

# yarn
yarn install

# npm
npm install

# pnpm
pnpm install --shamefully-hoist
# 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

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Look at the Nuxt 3 documentation to learn more.

TODO

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