Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liferay/senna.js
:seedling: A blazing-fast Single Page Application engine
https://github.com/liferay/senna.js
senna single-page-app spa
Last synced: about 2 months ago
JSON representation
:seedling: A blazing-fast Single Page Application engine
- Host: GitHub
- URL: https://github.com/liferay/senna.js
- Owner: liferay
- License: other
- Archived: true
- Created: 2014-08-09T19:13:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T17:56:31.000Z (over 3 years ago)
- Last Synced: 2024-09-22T02:35:14.163Z (about 2 months ago)
- Topics: senna, single-page-app, spa
- Language: JavaScript
- Homepage: http://sennajs.com
- Size: 14.4 MB
- Stars: 1,724
- Watchers: 65
- Forks: 170
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-blazingly-fast - senna.js - :seedling: A blazing-fast Single Page Application engine (JavaScript)
README
> :warning: In the future, [the `senna` npm package](https://npmjs.com/package/senna) will be deprecated and this repo archived (ie. switched to read-only mode). Development continues in [the `liferay/liferay-portal` repo](https://github.com/liferay/liferay-portal) (more specifically, inside [the `frontend-js-spa-web` module](https://github.com/liferay/liferay-portal/tree/master/modules/apps/frontend-js/frontend-js-spa-web)), but not as an independent project, in order to better integrate with and serve the needs of Liferay DXP. At the time of writing, the last official release was [v2.7.9](https://github.com/liferay/senna.js/tree/v2.7.9), from the `2.x` series on the `master` branch, and it is still used by a number of pre-EOL versions of Liferay DXP, such as [7.0.x](https://github.com/liferay/liferay-portal/blob/6b14c8e0496926309a5fac347cb2d342d7412c1f/modules/apps/foundation/frontend-js/frontend-js-spa-web/package.json#L6), [7.1.x](https://github.com/liferay/liferay-portal/blob/d9a4b24bf1871d509c2bb12e38669bb8552db1a5/modules/apps/frontend-js/frontend-js-spa-web/package.json#L17), [7.2.x](https://github.com/liferay/liferay-portal/blob/ded0e9390637985231e962e4ad4cfa4639eabb26/modules/apps/frontend-js/frontend-js-spa-web/package.json#L6), and [7.3.x](https://github.com/liferay/liferay-portal/blob/c940e8fd455d59fe05fd2038410070412411947c/modules/apps/frontend-js/frontend-js-spa-web/package.json#L6). Any maintenance releases required to the v2.x series of the npm package in the future will be made from [the liferay-frontend-projects monorepo](https://github.com/liferay/liferay-frontend-projects/tree/master/maintenance/projects/senna).
---
# Senna.js
[](https://travis-ci.org/liferay/senna.js)
[](https://david-dm.org/liferay/senna.js#info=dependencies)
[](https://david-dm.org/liferay/senna.js#info=devDependencies)
*Senna.js* is a blazing-fast single page application engine that provides several low-level APIs that allows you to build modern web-based applications with only ~15 KB of JavaScript without any dependency.
* [Official website](http://sennajs.com)
* [Website repository](https://github.com/liferay/sennajs.com)
* [Documentation](http://sennajs.com/docs/)
* [API Docs](http://sennajs.com/api/)
## Support and Project status
Senna.js is widely used and well maintained internally at Liferay but
does not currently have staffing to support the open source release. As such
this project is mostly _internal_ and support is _minimal_. For certain
issues, like build integration we are in an especially bad position to offer
support.
To get assistance you can use any of the following forums
1. Look through the [documentation](https://sennajs.com).
2. File an [issue on GitHub](https://github.com/liferay/senna.js/issues)
We will try our best, but keep in mind that given our support staffing, we may
not be able to help.
## Install
Install via [npm](https://www.npmjs.com/), [Bower](http://bower.io/), [CDN](http://www.jsdelivr.com/projects/senna.js) or
[download as a zip](https://github.com/liferay/senna.js/archive/master.zip):
```
npm install senna
```
## Examples
* **[Email Example](http://sennajs.com/examples/email):** *Enable Single Page Apps using only HTML5 data-attributes;*
* **[Gallery Example](http://sennajs.com/examples/gallery):** *Carousel app with history support and cacheable screens;*
* **[Blog Example](http://sennajs.com/examples/blog):** *Infinite scrolling pages done right with history support;*
## Setup
1. Install NodeJS >= [v0.12.0](http://nodejs.org/dist/v0.12.0/), if you don't have it yet.
2. Install global dependencies:
```
[sudo] npm install -g gulp
```
3. Install local dependencies:
```
npm install
bower install
```
4. Build the code:
```
gulp
```
```
gulp server
```
5. Test the code:
```
gulp test
```
```
gulp test:coverage
```
## Contributing
Please, see our detailed [CONTRIBUTING](https://github.com/liferay/senna.js/blob/master/CONTRIBUTING.md) guide for all the information you need to contribute to the project!
## History
For detailed changelog, check [Releases](https://github.com/liferay/senna.js/releases).
## Credits
* Inspired by Daniel Pupius' [Surface project](https://github.com/dpup/surface)
* Demo layouts by [Pure CSS](http://purecss.io/)
* Icon made by [Freepik](http://www.freepik.com)
## Team
*Senna.js* was made with love by these people and a bunch of [awesome contributors](https://github.com/liferay/senna.js/graphs/contributors).
| Author | Maintainer |
|:-:|:-:|
| [](https://github.com/eduardolundgren) | [](https://github.com/brunobasto) |
| [Eduardo Lundgren](https://github.com/eduardolundgren) | [Bruno Basto](https://github.com/brunobasto) |
## Browser Support
[](https://travis-ci.org/liferay/senna.js)
## License
[BSD License](https://github.com/liferay/senna.js/blob/master/LICENSE.md) © Liferay, Inc.