Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bradp/pears

🍐️ A starter kit for building static sites quickly, easily, and efficiently.
https://github.com/bradp/pears

hugo hugo-boilerplate hugo-starter hugo-theme starter starter-kit starter-template static-site tailwind tailwindcss

Last synced: about 2 months ago
JSON representation

🍐️ A starter kit for building static sites quickly, easily, and efficiently.

Host: GitHub
URL: https://github.com/bradp/pears
Owner: bradp
License: mit
Created: 2020-12-15T19:51:40.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-01-03T07:56:56.000Z (about 2 years ago)
Last Synced: 2024-10-19T12:19:52.782Z (3 months ago)
Topics: hugo, hugo-boilerplate, hugo-starter, hugo-theme, starter, starter-kit, starter-template, static-site, tailwind, tailwindcss
Language: HTML
Homepage: https://pears.cloud
Size: 7.93 MB
Stars: 11
Watchers: 3
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 🍐️ Pears - A Static Site Starter Kit

illustration of pears

A starter kit for building static sites quickly, easily, and efficiently.

Build Status

Last commit

View live demo →

:warning: Currently, Pears is in an early state of development. Things may break & change.

## 🏆 Goals

- Super simple to use and develop with. No messing with settings and configurations.
- Easy to use for those who are not familiar with Hugo. They shouldn't have to learn more than the basics.
- Powered by tools that are focused on a quick and efficient development cycle.
- Pre-packed with shortcodes & partials for a ton of different components.

## 🎉️ What's included?

🚧 **[Hugo](https://gohugo.io)** - The fastest framework for building static sites

🎨 **[TailwindCSS](https://tailwind.css)**, **[Tailwind Forms](https://github.com/tailwindlabs/tailwindcss-forms)**, and **[Tailwind Typography](https://github.com/tailwindlabs/tailwindcss-typography)** Utility-first CSS framework to build your site without ever having to leave your HTML.

🔧️ **[PostCSS](https://github.com/postcss/postcss)**, **[autoprefixer](https://github.com/postcss/autoprefixer)**, and **[PurgeCSS](https://github.com/FullHuman/purgecss)** Trim your CSS files (including Tailwind's) to be _only_ the classes and rules you actually use in your markup.

🌈️ **[Prettier](https://github.com/prettier/prettier)** and **[stylelint](https://github.com/stylelint/stylelint)** Write better code without having to think about formatting.

🔍️ **[ESLint](https://eslint.org)** Never run into JS errors again.

## 🚀️ Getting Started

Getting set up for using this project requires install a few different things. Don't worry, it's easy.

### Requirements

You will need to [install Hugo](https://gohugo.io/getting-started/installing/) if you don't already have it. There are [pre-built binary files](https://github.com/gohugoio/hugo/releases) available for almost every platform.

### Installing

Once you have Yarn and Hugo installed on your system, all you need to do is grab a copy of Pears and install the dependencies.

```
git clone https://github.com/bradp/pears
cd
npm i
```

## ⚡️ Usage

- To start up your local development environment: `npm start`
- To see a full list of available commands: `npm run`

#### Main Commands
Command | Action
:- | :-
`npm start` | Builds all files & starts up the development server
`npm build` | Builds all files for a local or staging environment
`npm build:prod` | Builds all files for a deployment to a production server
`npm lint` | Check your CSS & JS files for errors Append `:fix` to automatically fix
`npm format` | Fix formatting errors automatically

Remember, you can always check yarn run to see full list of commands!

## 🔮️ Roadmap

See the [open issues](https://github.com/bradp/starter/issues) for a list of proposed features (and known issues).

## 📕️ License

Distributed under the MIT License. See `LICENSE` for more information.