README.md

techexcellence-site

techexcellence.dev website for the Tech Excellence events.

Developing the site

Site structure

Directory structure

• src
  • Source data for the website contents
• docs
  • Output directory (automatically generated by Eleventy)
  • Don't put anything to docs directory manually, as it will be overwritten.
• scripts
  • Helper tools for local development

Getting started

• Install Node.js (if you don't already have it on your computer)
• Install dependencies with npm by running following commands:

npm install

Development environment

npm run dev

Build output

npm run build

Trying Netlify locally

Netlify CLI allows testing of local development environment with similar features as in hosted environment on Netlify.

netlify dev

More details:

• Command Line Tools | Netlify

Dependencies

• Node.js (environment for running JavaScript-based tools)
• Eleventy (static site generator)

Optional dependencies:

• netlify-cli for running Netlify tools locally

npm dependencies

• npm-run-all package
  • "A CLI tool to run multiple npm-scripts in parallel or sequential."
    • Motivation for the usage:
      • Simplify running multiple commands.
      • Cross platform support for running parallel tasks.
  • Documentation
    • npm-run-all command
    • npm-run-all command to run given npm-scripts sequentially.
    • npm-run-all command to run given npm-scripts in parallel.
• cross-env
  • Allow running scripts that set and use environment variables, across most platforms.
  • Documentation about cross-env usage.