MWDelaney / cloud-cannon

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸͺZeroPoint

A free, new-user-friendly website starter project designed to walk you through creating, editing, and publishing any web project; from a personal blog, to a company website!

Read more at https://getzeropoint.com!

What is ZeroPoint?

For new users

ZeroPoint is a free, new-user-friendly website starter designed to walk you through creating and publishing a fast, secure web project using modern tools and technology. ZeroPoint makes it easy to "get up to zero" and start building your site.

For experienced developers

ZeroPoint is a modern, opinionated, bare-bones Jamstack starter using Eleventy to get "up to zero" on a project quickly and easily. Why you might choose ZeroPoint as your Jamstack starter:

  • Powered by Eleventy, which rocks!
  • No CSS frameworks or libraries; use whatever you like best
  • GitHub Action replaces the ZeroPoint name throughout the site with your project's name!
  • Custom generated project-specific readme file to help you take the next steps and launch your project!
  • Sass for CSS
  • Javascript compilation and minification
  • Browsersync to preview your work

Get started: Use This Template

Get started with ZeroPoint one of the following ways:

Start with GitHub

Create a new project using ZeroPoint and add it to your GitHub account

Start with Netlify

Create a copy of ZeroPoint and deploy it straight to Netlify for free!

Deploy to Netlify

With GitHub CLI (https://cli.github.com)

Get started from your command line

 gh repo create example.com --template MWDelaney/ZeroPoint

Get to Know ZeroPoint

Ready to go deeper? Here's how ZeroPoint is laid out:

example.com                 # β†’ Root of your ZeroPoint-based project
β”œβ”€β”€ src/                    # β†’ Source directory
β”‚   β”œβ”€β”€ assets/             # β†’ Site assets
β”‚   β”‚   β”œβ”€β”€ fonts/
β”‚   β”‚   β”œβ”€β”€ images/
β”‚   β”‚   β”œβ”€β”€ scripts/
β”‚   β”‚   β”œβ”€β”€ styles/
β”‚   β”‚   β”œβ”€β”€ views/
β”‚   β”‚   β”‚   └── layouts/
β”‚   β”‚   β”‚   └── partials/
β”‚   β”‚   └── assets.json     # β†’ Shared attributes for files in the assets directory
β”‚   β”œβ”€β”€ config/             # β†’ Eleventy configuration
β”‚   β”‚   β”œβ”€β”€ collections.js  # β†’ Add and configure collections (https://www.11ty.dev/docs/collections/)
β”‚   β”‚   β”œβ”€β”€ filters.js      # β†’ Add and configure filters (https://www.11ty.dev/docs/filters/)
β”‚   β”‚   β”œβ”€β”€ passthroughs.js # β†’ Add and configure passthroughs (https://www.11ty.dev/docs/copy/)
β”‚   β”‚   β”œβ”€β”€ plugins.js      # β†’ Add and configure plugins (https://www.11ty.dev/docs/plugins/)
β”‚   β”‚   β”œβ”€β”€ shortcodes.js   # β†’ Add and configure shortcodes (https://www.11ty.dev/docs/shortcodes/)
β”‚   β”‚   β”œβ”€β”€ templateLanguages.js   # β†’ Configure custom template languages (HINT: this is where ZeroPoint's Sass and Javascript pipelines are set up!) (https://www.11ty.dev/docs/languages/custom/)
β”‚   β”‚   β”œβ”€β”€ watchtargets.js # β†’ Add and configure watch targets (https://www.11ty.dev/docs/watch-serve/)
β”‚   β”‚   └── config.json     # β†’ Shared attributes for files in the config directory
β”‚   β”œβ”€β”€ content             # β†’ A nice, organized, recommended place for all site content
β”‚   β”‚   └── pages           # β†’ Add "pages" collection items here
β”‚   └── data                # β†’ Customize site data (https://www.11ty.dev/docs/data/)
β”‚       β”œβ”€β”€ navigation.json # β†’ Site navigation configuration
β”‚       └── site.json       # β†’ Site branding configuration
β”œβ”€β”€ .eleventy.js            # β†’ Core Eleventy config file
β”œβ”€β”€ netlify.toml            # β†’ Netlify deployment and plugin configuration (optional)
β”œβ”€β”€ README.template.md      # β†’ ZeroPoint readme
└── README.md               # β†’ Your project's readme (automatically generated when this template is used)

Eleventy Configuration

Eleventy configuration is abstracted from the typical .eleventy.js file and moved to /src/config/ for easy organization and configuration of collections, filters, passthroughs, etc.

Install project dependencies

npm i

Run the project locally

npm run dev

Build for staging

(The same as production except every page is flagged noindex)

npm run staging

Build for production

npm run production

About

License:MIT License


Languages

Language:JavaScript 59.2%Language:Nunjucks 27.4%Language:SCSS 13.4%