• Stars
    star
    976
  • Rank 46,914 (Top 1.0 %)
  • Language
    JavaScript
  • Created almost 9 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🎸 Ready-to-rock Preact starter project, powered by Webpack.

Preact Boilerplate / Starter Kit Build Status Preact Slack Community

🎸 Ready-to-rock Preact starter project, powered by webpack. (View Demo)

🚀 Note: We now recommend Preact CLI for new projects.

Preact CLI is a natural evolution of this boilerplate, and improves on it in every way. In a single dependency, you get a friendly command line project creation and build tool with development & production modes. Preact CLI requires no configuration at all, and even does automatic code-splitting without you lifting a finger! It also produces bundles roughly half the size of preact-boilerplate.


Quick-Start Guide

Installation

1. Clone this repo:

git clone --depth 1 https://github.com/developit/preact-boilerplate.git my-app
cd my-app

2. Make it your own:

rm -rf .git && git init && npm init

ℹī¸ This re-initializes the repo and sets up your NPM project.

3. Install the dependencies:

npm install

You're done installing! Now let's get started developing.

Development Workflow

4. Start a live-reload development server:

npm run dev

This is a full web server nicely suited to your project. Any time you make changes within the src directory, it will rebuild and even refresh your browser.

5. Testing with mocha, karma, chai, sinon via phantomjs:

npm test

🌟 This also instruments the code in src/ using isparta, giving you pretty code coverage statistics at the end of your tests! If you want to see detailed coverage information, a full HTML report is placed into coverage/.

6. Generate a production build in ./build:

npm run build

You can now deploy the contents of the build directory to production!

Surge.sh Example: surge ./build -d my-app.surge.sh

Netlify Example: netlify deploy

Deploy to Netlify

5. Start local production server with serve:

npm start

This is to simulate a production (CDN) server with gzip. It just serves up the contents of ./build.


Structure

Apps are built up from simple units of functionality called Components. A Component is responsible for rendering a small part of an application, given some input data called props, generally passed in as attributes in JSX. A component can be as simple as:

class Link extends Component {
  render({ to, children }) {
    return <a href={ to }>{ children }</a>;
  }
}
// usage:
<Link to="/">Home</Link>

CSS Modules

This project is set up to support CSS Modules. By default, styles in src/style are global (not using CSS Modules) to make global declarations, imports and helpers easy to declare. Styles in src/components are loaded as CSS Modules via Webpack's css-loader. Modular CSS namespaces class names, and when imported into JavaScript returns a mapping of canonical (unmodified) CSS classes to their local (namespaced/suffixed) counterparts.

When imported, this LESS/CSS:

.redText { color:red; }
.blueText { color:blue; }

... returns the following map:

import styles from './style.css';
console.log(styles);
// {
//   redText: 'redText_local_9gt72',
//   blueText: 'blueText_local_9gt72'
// }

Note that the suffix for local classNames is generated based on an md5 hash of the file. Changing the file changes the hash.


Handling URLS

💁 This project contains a basic two-page app with URL routing.

Pages are just regular components that get mounted when you navigate to a certain URL. Any URL parameters get passed to the component as props.

Defining what component(s) to load for a given URL is easy and declarative. You can even mix-and-match URL parameters and normal props.

<Router>
  <A path="/" />
  <B path="/b" id="42" />
  <C path="/c/:id" />
</Router>

React Compatibility

This project includes preact-compat alias in as react and react-dom right out-of-the-box. This means you can install and use third-party React components, and they will use Preact automatically! It also means that if you don't install third-party React components, preact-compat doesn't get included in your JavaScript bundle - it's free if you don't use it 👍


License

MIT

More Repositories

1

mitt

đŸĨŠ Tiny 200 byte functional event emitter / pubsub.
TypeScript
9,030
star
2

htm

Hyperscript Tagged Markup: JSX alternative using standard tagged templates, with compiler support.
JavaScript
8,661
star
3

microbundle

đŸ“Ļ Zero-configuration bundler for tiny modules.
JavaScript
8,055
star
4

unfetch

🐕 Bare minimum 500b fetch polyfill.
JavaScript
5,637
star
5

greenlet

đŸĻŽ Move an async function into its own thread.
JavaScript
4,621
star
6

workerize

🏗ī¸ Run a module in a Web Worker.
JavaScript
4,287
star
7

redaxios

The Axios API, as an 800 byte Fetch wrapper.
JavaScript
4,131
star
8

unistore

đŸŒļ 350b / 650b state container with component actions for Preact & React
JavaScript
2,865
star
9

express-es6-rest-api

🔋 Starter project for an ES6 RESTful Express API.
JavaScript
2,460
star
10

workerize-loader

🏗ī¸ Automatically move a module into a Web Worker (Webpack loader)
JavaScript
2,283
star
11

snarkdown

đŸ˜ŧ A snarky 1kb Markdown parser written in JavaScript
JavaScript
2,180
star
12

stockroom

🗃 Offload your store management to a worker easily.
JavaScript
1,758
star
13

dlv

Safe deep property access in 120 bytes. x = dlv(obj, 'a.b.x')
JavaScript
1,217
star
14

karmatic

đŸĻ‘ Easy automatic (headless) browser testing with Jest's API, but powered by Karma & Webpack.
JavaScript
1,181
star
15

decko

💨 The 3 most useful ES7 decorators: bind, debounce and memoize
JavaScript
1,038
star
16

web-worker

Consistent Web Workers in browser and Node.
JavaScript
949
star
17

vhtml

Render JSX/Hyperscript to HTML strings, without VDOM 🌈
JavaScript
740
star
18

histore

đŸŦ 200b key-value store backed by navigation state
JavaScript
677
star
19

optimize-plugin

Optimized Webpack Bundling for Everyone. Intro â¤ĩī¸
JavaScript
659
star
20

undom

🍩 1kb minimally viable DOM Document implementation
JavaScript
654
star
21

asyncro

â›ĩī¸ Beautiful Array utilities for ESnext async/await ~
JavaScript
493
star
22

nextjs-preact-demo

Next.js 9.3 + Preact = 21kB
JavaScript
384
star
23

tags-input

🔖 <input type="tags"> like magic
JavaScript
328
star
24

linkstate

Bind events to state. Works with Preact and React.
JavaScript
296
star
25

preact-redux

âžŋ Preact integration for Redux (no shim needed!)
JavaScript
288
star
26

task-worklet

Task Worklet: explainer, polyfill and demos.
JavaScript
275
star
27

jsdom-worker

👷‍♀ī¸ Use Web Workers in Jest / JSDOM 🌈
JavaScript
273
star
28

preact-worker-demo

Demo of preact rendering an entire app in a Web Worker.
JavaScript
217
star
29

preact-virtual-list

📇 Virtual List that only renders visible items. Supports millions of rows.
JavaScript
215
star
30

jsxobj

Build JSON using JSX 🌈 (may contain blood magic)
JavaScript
214
star
31

preact-redux-example

🔁 Preact + Redux Example Project
JavaScript
201
star
32

preact-markup

⚡ Render HTML5 as VDOM, with Components as Custom Elements!
JavaScript
195
star
33

simple-element-resize-detector

Observes element size changes using a hidden iframe
JavaScript
190
star
34

preact-mdl

đŸ’Ĩ A collection of Preact Components that encapsulate Google's Material Design Lite.
JavaScript
186
star
35

zero-to-preact

A Step-by-step Guide to Preact + Webpack 2, without boilerplate!
JavaScript
179
star
36

state-machine-component

⚙ī¸ State machine -powered components in 250 bytes
JavaScript
177
star
37

preact-portal

📡 Render Preact components in (a) SPACE 🌌 🌠
JavaScript
176
star
38

preact-photon

🚀 Beautiful desktop apps with Preact + Photon ❤ī¸
JavaScript
173
star
39

preact-slots

đŸ•ŗ Render Preact trees into other Preact trees, like portals.
JavaScript
157
star
40

oss.ninja

👩‍⚖ī¸ Dynamic licenses for your projects - no more LICENSE.txt!
JavaScript
146
star
41

preact-cycle

â™ģī¸ Minimal functional Virtual DOM rendering using Preact 🚲
JavaScript
131
star
42

dropfox

đŸĻŠ 📂 A dropbox client powered by Preact, Electron and Photon
JavaScript
122
star
43

preact-scroll-viewport

Preact Component that renders homogeneous children only when visible
JavaScript
121
star
44

babel-preset-modernize

JavaScript
121
star
45

resource-router-middleware

🚴 Express REST resources as middleware mountable anywhere
JavaScript
120
star
46

object-diff-patch

JavaScript
103
star
47

preact-todomvc

đŸ’Ŗ TodoMVC done in Preact. Under 6kb and fast.
JavaScript
102
star
48

restful-mongoose

đŸĻ Expose Mongoose models as RESTful Express resources.
JavaScript
90
star
49

modify-babel-preset

đŸ’Ģ Create a modified babel preset based on an an existing preset.
JavaScript
85
star
50

preact-without-babel

🐎 How to use Preact in (native) ES2015, without Babel or JSX.
JavaScript
79
star
51

preact-shadow-root

🕴 Render a Preact subtree into the Shadow DOM.
JavaScript
72
star
52

linkref

Like Linked State, but for Refs. Works with Preact and React.
JavaScript
61
star
53

preact-css-transition-group

Apply CSS transitions when adding or removing Preact components/elements
JavaScript
61
star
54

proptypes

💂‍♂ī¸ React's PropTypes, as a standalone module.
JavaScript
59
star
55

preact-token-input

🔖 A text field that tokenizes input, for things like tags.
JavaScript
59
star
56

nectarine

🍑 A mobile web / Android app for Peach! (peach.cool) ⚡
JavaScript
59
star
57

unified-element-properties-proposal

Unified Element Properties for the DOM
58
star
58

preact-jsx-chai

✅ Add JSX assertions to Chai, with support for Preact Components.
JavaScript
56
star
59

preact-compat-example

🚤 Demo of preact-compat + react-toolbox to reduce build size by 95%.
JavaScript
52
star
60

preact-transition-group

transition-group ui component for preact
JavaScript
51
star
61

scroll-list

📜 An infinitely scrollable list/datagrid. Handles millions of rows.
JavaScript
48
star
62

preact-in-es3

🐴 How to use Preact without Babel, ES2015 or JSX.
JavaScript
46
star
63

rollup-plugin-preserve-shebang

Rollup plugin to automatically preserve shebangs in entry modules.
JavaScript
45
star
64

preact-cli-plugin-async

Preact CLI plugin that adds converts async/await to Promises.
JavaScript
44
star
65

preact-views

đŸ“ē Named views for Preact, with easy-as-pie linking between them.
JavaScript
39
star
66

preact-richtextarea

📰 A text field that supports HTML editing. 📝
JavaScript
39
star
67

react-router-4-test

Did you know you can use React Router with Preact, no -compat?
JavaScript
35
star
68

element-worklet

34
star
69

documentation-viewer

📜 Hosted viewer for documentation.js JSON output.
JavaScript
34
star
70

sleeper

😴 REST abstraction so easy you could use it with your eyes closed. 💤
JavaScript
30
star
71

neatime

Returns a simple relative time string.
JavaScript
30
star
72

babel-preset-preact

Babel preset to transform JSX into h() calls
JavaScript
30
star
73

ama

Ask me stuff
28
star
74

htmlParser

Simple JavaScript HTML parser.
JavaScript
27
star
75

precharts

Just Recharts pre-aliased for Preact.
JavaScript
27
star
76

object-shape

Get a description of a JS object's shape.
JavaScript
24
star
77

eslint-config-developit

developit's generic eslint config for libraries
JavaScript
21
star
78

peach.cool

🍑 JavaScript library for Peach (peach.cool) ⚡
JavaScript
21
star
79

progress-spinner

⌚ A simple, CSS-only indeterminate spinner custom element.
HTML
21
star
80

rollup-plugin-postprocess

🎞 Find & replace postprocessing for Rollup output
JavaScript
18
star
81

desky

18
star
82

jasonformat.com

My blog
JavaScript
18
star
83

preact-tap-event-plugin

☝ī¸ onTouchTap for preact
JavaScript
17
star
84

preact-svg

[DEPRECATED] 🎨 Use inline <svg> in Preact 4 and prior. 🌷
JavaScript
16
star
85

preact-styled-jsx-demo

Preact + styled-jsx = 💞
JavaScript
16
star
86

preact-vite-template

JavaScript
15
star
87

espz

JavaScript
13
star
88

microbundle-2

JavaScript
13
star
89

hazelnut

🌰 Tiny inline AMD registry.
JavaScript
12
star
90

puredom

💲 Fast, chainable and exstensible JavaScript library for building web applications.
JavaScript
11
star
91

request-easy-cache

🐎 A simple, configurable & instantiable caching wrapper around request.
JavaScript
11
star
92

templeton

đŸ’Ē Templating like the other ones, but not at all like the other ones.
JavaScript
10
star
93

bamboo-status-svg

A web service that generates build badges for Bamboo plans.
JavaScript
9
star
94

ford.js

👔 The library nobody wants but that is for some reason still mayor.
JavaScript
8
star
95

jasonp

An itty bitty JSONP module
JavaScript
7
star
96

browser-nativefs

Native File System API with legacy fallback in the browser
JavaScript
7
star
97

strip-dom-whitespace

Traverses the DOM to strip whitespace-only Text nodes
JavaScript
6
star
98

picomarkdown

Converts basic markdown to HTML.
JavaScript
6
star
99

babel-preset-es2015-minimal

💄 Babel's es2015 preset in loose mode without frills.
JavaScript
5
star
100

esbench

ESBench Feedback (future public repo)
4
star