https://github.com/unpoly/unpoly
Progressive enhancement for HTML
https://github.com/unpoly/unpoly
html html-driven html-over-the-wire progressive-enhancement server-side-rendering server-side-technologies ujs unobtrusive-javascript
Last synced: 24 days ago
JSON representation
Progressive enhancement for HTML
- Host: GitHub
- URL: https://github.com/unpoly/unpoly
- Owner: unpoly
- License: mit
- Created: 2016-02-21T11:43:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-05-12T20:20:43.000Z (24 days ago)
- Last Synced: 2025-05-13T00:12:33.575Z (24 days ago)
- Topics: html, html-driven, html-over-the-wire, progressive-enhancement, server-side-rendering, server-side-technologies, ujs, unobtrusive-javascript
- Language: JavaScript
- Homepage:
- Size: 18.4 MB
- Stars: 2,524
- Watchers: 23
- Forks: 81
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Progressive enhancement for HTML
--------------------------------
[Unpoly](https://unpoly.com) enhances your HTML with attributes to build dynamic UI on the server.
Unpoly works with any language or framework. It plays nice with existing code, and gracefully degrades without JavaScript.
This branch tracks the current major version, Unpoly **3.x**.\
If you're using Unpoly **2.x**, use the [`2.x-stable`](https://github.com/unpoly/unpoly/tree/2.x-stable) branch.\
If you're using Unpoly **1.x** or **0.x**, use the [`1.x-stable`](https://github.com/unpoly/unpoly/tree/1.x-stable) branch.
Getting started
---------------
- See [unpoly.com](https://unpoly.com) for guides and documentation.
- See [installation instructions](https://unpoly.com/install) for many different package managers and languages.
- See [discussions](https://github.com/unpoly/unpoly/discussions) for our community forum.
- See [notable changes](https://unpoly.com/changes).
Development
-----------
### Installing development dependencies
To build Unpoly you require Node.js, Webpack and other npm packages.
Install the Node version from `.nvmrc`.
To install required npm packages, run:
```
npm install
```
### Quick start
The following will build the library and start a server to run tests:
```
npm run dev
```
Allow a moment for Unpoly and tests to build in `dist/`. Changing a file will re-build automatically.
You can now run tests using one of the following methods:
- From your console, using `npm run test`
- In a browser, by accessing `http://localhost:4000`
If you don't want to use `npm run dev` and prefer to run individual tasks instead, see below.
### Building the library
Tests don't consume the sources directly, but from a transpiled build in `dist/`.
To make fresh build for development, run:
```
npm run build-dev
```
This will build transpiled files such as:
```
dist/unpoly.js
dist/unpoly.css
dist/unpoly-migrate.js
dist/jasmine.js
dist/specs.js
```
There is also a task `npm run build` for a production build. This does not build files for testing, but also outputs minified versions.
### Watching files for changes
During development it is impractical to make a full build after every change. Instead it is recommend to watch the project:
```
npm run watch-dev
```
This will make a fresh build and then watch the project for changes to the source files.
hen a source changes, affected build files are automatically recompiled. The incremental recompilation is much faster than a full build.
### Running tests
Tests need a small background server to run:
```
npm run test-server &
```
You can now run tests using one of the following methods:
- From your console, using `npm run test`
- In a browser, by accessing `http://localhost:4000`
In addition to the unit tests, there is an optional support repo [`unpoly-manual-tests`](https://github.com/unpoly/unpoly-manual-tests). It contains a Rails app to play with Unpoly features that are hard to test well with a unit test. E.g. the visual look of overlays, or edge cases when booting Unpoly.
### Making a new release
There is a guided CLI interface to lead you through the release process. To start the process run:
```
npm run release
```
Credits
-------
- [Henning Koch](mailto:[email protected]) from [makandra](https://makandra.com) ([@triskweline](https://twitter.com/triskweline) on Twitter)
- [Contributors](https://github.com/unpoly/unpoly/graphs/contributors)