\n\n\nProgressive enhancement for HTML\n--------------------------------\n\n[Unpoly](https://unpoly.com) enhances your HTML with attributes to build dynamic UI on the server.\n\nUnpoly works with any language or framework. It plays nice with existing code, and gracefully degrades without JavaScript.\n\nThis branch tracks the current major version, Unpoly **3.x**.\\\nIf you're using Unpoly **2.x**, use the [`2.x-stable`](https://github.com/unpoly/unpoly/tree/2.x-stable) branch.\\\nIf you're using Unpoly **1.x** or **0.x**, use the [`1.x-stable`](https://github.com/unpoly/unpoly/tree/1.x-stable) branch.\n\n\nGetting started\n---------------\n\n- See [unpoly.com](https://unpoly.com) for guides and documentation.\n- See [installation instructions](https://unpoly.com/install) for many different package managers and languages.\n- See [discussions](https://github.com/unpoly/unpoly/discussions) for our community forum.\n- See [notable changes](https://unpoly.com/changes).\n\n\nDevelopment\n-----------\n\n### Installing development dependencies\n\nTo build Unpoly you require Node.js, Webpack and other npm packages.\n\nInstall the Node version from `.nvmrc`.\n\nTo install required npm packages, run:\n\n```\nnpm install\n```\n\n### Quick start\n\nThe following will build the library and start a server to run tests:\n\n```\nnpm run dev\n```\n\nAllow a moment for Unpoly and tests to build in `dist/`. Changing a file will re-build automatically.\n\nYou can now run tests using one of the following methods:\n\n- From your console, using `npm run test`\n- In a browser, by accessing `http://localhost:4000` \n\nIf you don't want to use `npm run dev` and prefer to run individual tasks instead, see below.\n\n\n### Building the library\n\nTests don't consume the sources directly, but from a transpiled build in `dist/`.\n\nTo make fresh build for development, run:\n\n```\nnpm run build-dev\n```\n\nThis will build transpiled files such as:\n\n```\ndist/unpoly.js\ndist/unpoly.css\ndist/unpoly-migrate.js\ndist/jasmine.js\ndist/specs.js\n```\n\nThere is also a task `npm run build` for a production build. This does not build files for testing, but also outputs minified versions.\n\n### Watching files for changes\n\nDuring development it is impractical to make a full build after every change. Instead it is recommend to watch the project:\n\n```\nnpm run watch-dev\n```\n\nThis will make a fresh build and then watch the project for changes to the source files. \n\nWhen a source changes, affected build files are automatically recompiled. The incremental recompilation is much faster than a full build.\n\n### Running tests\n\nTests need a small background server to run:\n\n```\nnpm run test-server &\n```\n\nYou can now run tests using one of the following methods:\n\n- From your console, using `npm run test`\n- In a browser, by accessing `http://localhost:4000`\n\nIn 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.\n\n### Making a new release\n\nThere is a guided CLI interface to lead you through the release process. To start the process run:\n\n```\nnpm run release\n```\n\n\n\nCredits\n-------\n\n- [Henning Koch](mailto:henning.koch@makandra.de) from [makandra](https://makandra.com) ([@triskweline](https://twitter.com/triskweline) on Twitter)\n- [Contributors](https://github.com/unpoly/unpoly/graphs/contributors)\n","readmeFilename":"README.md"}
![\"Sponsored](\"media/sponsored-by-makandra.light.svg\")
\n ![\"Unpoly](\"media/unpoly-logo.light.svg\"){kind=logo}
\n ![\"jsDelivr](\"https://img.shields.io/jsdelivr/npm/hy/unpoly\")
![\"NPM](\"https://img.shields.io/npm/dy/unpoly?label=npm\")