Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.75 KB

README.md

File metadata and controls

69 lines (46 loc) · 2.75 KB
Raw

The code that powers paulsmith.site

Feel free to take the code to make your own website.

Set-up

You will need:

  1. NodeJS
  2. Yarn/NPM
  3. NPX
  4. VSCode
  5. Prettier Extension for VSCode
  6. ESLint Extension for VSCode

I like to use a linter and a formatter. The linter will allow us to detect bugs early, and the formatter will help us maintain consistency throughout our codebase. With both these extensions working side-by-side, we should be able to build clean and maintainable code.

Get your local environment set-up (assumes Mac)

  1. Install Homebrew
  2. Install Node and NPM with brew install node
  3. Install yarn. See official Yarn installation instructions.
  4. Fork then clone this repository
  5. Install the dependancies with yarn install

Get the editor running correctly

  1. Download the ESLint and Prettier extensions for VSCode.

  2. Install the ESLint and Prettier libraries into our project. In your project’s root directory, you will want to run: npm install -D eslint prettier

  3. Install the Airbnb config. If you’re using npm 5+, you can run this shortcut to install the config and all of its dependencies: npx install-peerdeps --dev eslint-config-airbnb

  4. Install eslint-config-prettier (disables formatting for ESLint) and eslint-plugin-prettier (allows ESLint to show formatting errors as we type) npm install -D eslint-config-prettier eslint-plugin-prettier

  5. Create .eslintrc.json file in your project’s root directory:

{
  "extends": ["airbnb", "prettier"],
  "plugins": ["prettier"],
  "rules": {
    "prettier/prettier": ["error"]
  },
}

  1. Create .prettierrc file in your project’s root directory. This will be where you configure your formatting settings. I have added a few of my own preferences below, but I urge you to read more about the Prettier config file

  2. The last step is to make sure Prettier formats on save. Insert "editor.formatOnSave": true into your User Settings in VSCode.

Using this static site generator

Running the local server

You can get a local server running by typing: npm start

Creating a production build

Get a compiled and optimise build by typing: npm build

Local debugging

DEBUG=* npx @11ty/eleventy --config=app/eleventy/eleventy.config.js