Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 2 months 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 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T07:43:44.000Z (about 2 months ago)
- Last Synced: 2024-07-31T11:23:05.545Z (about 2 months ago)
- Topics: html, html-driven, html-over-the-wire, progressive-enhancement, server-side-rendering, server-side-technologies, ujs, unobtrusive-javascript
- Language: JavaScript
- Homepage:
- Size: 16.8 MB
- Stars: 2,166
- Watchers: 23
- Forks: 73
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[Unpoly 3](https://unpoly.com)
==============================
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 Webpack and other required npm packages, run:
```
npm install
```
### Quick start
The following will build the library and open a web browser with the test suite:
```
npm run dev
```
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, 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. When a source changes, affected build files are automatically recompiled. The incremental recompilation is much faster than a full build.
### Running tests
Tests run using a browser-based [Jasmine](https://jasmine.github.io/) runner.
To start a web server serving the Jasmine runner:
```
npm run test
```
This will open a server on and opens that URL with your default browser.
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
You can use this repository to publish a new version of the `unpoly` npm package.
The release process currently requires Ruby. To install these dependencies:
- Install the Ruby version from `.ruby-version`
- Run `bundle install`
There is a guided CLI interface to lead you through the release process. To start the process run:
```
bundle exec rake release:process
```
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)