Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/justintime50/pineapple
CSS and Javascript web development library that supplements Bootstrap.
https://github.com/justintime50/pineapple
bootstrap css development framework javascript js library pineapple sass scss web web-development
Last synced: 17 days ago
JSON representation
CSS and Javascript web development library that supplements Bootstrap.
- Host: GitHub
- URL: https://github.com/justintime50/pineapple
- Owner: Justintime50
- License: mit
- Created: 2019-05-08T05:24:42.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T20:03:57.000Z (4 months ago)
- Last Synced: 2024-10-25T06:48:38.283Z (25 days ago)
- Topics: bootstrap, css, development, framework, javascript, js, library, pineapple, sass, scss, web, web-development
- Language: JavaScript
- Homepage: https://justintime50.github.io/pineapple
- Size: 1.56 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Pineapple
CSS and Javascript web development library that supplements Bootstrap.
[](https://github.com/Justintime50/pineapple/actions)
[](https://www.npmjs.com/package/pineapple-library)
[](LICENSE)
Pineapple came about as a way to help me quickly build "brochure-style" websites some years ago. I found I was copying and pasting a lot of custom CSS around my projects to extend Bootstrap's library and decided to build my own. Over the years as Bootstrap evolved, certain Pineapple functions were removed in favor of the better battle-tested Bootstrap equivalent. Pineapple still serves as a nice addition to any Bootstrap project.
**Notable Features:**
- Full-screen banners, YouTube videos, and Bootstrap carousels with incredible customization for overlaid text, images, and buttons
- Beautiful sliding animations (full page and individual components)
- Page loader animation
- Countdown timer with custom messaging
- Fading and appearing navbar
- Icons, cards, and slanted background sections
- Dynamic screen-sized fonts, buttons, and more
## Install
Pineapple has been compiled into CSS from SCSS and JS. You will find either the beautified or minified equivelant of each along with source maps.
### CDN
```html
```
### NPM
```bash
npm install pineapple-library
```
### Composer
```bash
composer require justintime50/pineapple
```
### Webpack & Vite
**NOTE:** Requires Pineapple v2.2+
Once installed via NPM, include one of the following in your Webpack or Vite configs and compile your project:
```javascript
// Require
window.pineapple = require('pineapple-library/pineapple/dist/js/pineapple');
// Import
import pineapple from 'pineapple-library/pineapple/dist/js/pineapple';
window.pineapple = pineapple;
```
### SCSS
To import the project's SCSS, use the following line in your project:
```scss
@import 'pineapple-library/pineapple/scss/pineapple';
```
### Manual Download
1. Clone the repo
1. Manually import the Pineapple assets to your project
```bash
git clone https://github.com/justintime50/pineapple.git
```
The Pineapple CSS has been compiled into three separate bundles:
- `pineapple` includes everything
- `pineapple-styles` includes everything but the `grid` and `animations` CSS and can be used without the accompanying JS
- `pineapple-utilities` includes the `grid` and `animations` CSS which accompanies the JS
### Pineapple, Bootstrap, & jQuery
#### Bootstrap
- Pineapple v1 is compatible with Bootstrap v3 (requires jQuery)
- Pineapple v2 is compatible with Bootstrap v4 and v5 (requires jQuery)
- Pineapple v3 & v4 are compatible with Bootstrap v4 and v5
#### jQuery
- Pineapple v1 and v2 require jQuery and is not compatible with the `slim` version of jQuery. Pineapple v3 and later does not require jQuery
## Documentation
See the accompanying [Documentation](/docs/README.md) for more information.
## Development
Visit `pineappleplayground.localhost` locally to test any changes.
```bash
# Lint CSS
npm run lint-css
# Lint JS
npm run lint-js
# Compile CSS from SCSS and JS assets
npm run compile
```
## Releasing
1. Bump version in `package.json` and `composer.json`
1. Bump version in `CHANGELOG.md`
1. Bump version in `scss` and `js` header comments
1. Bump version in install instruction links in `README.md`
1. Compile assets with `npm run compile`
1. Cut a new Git tag which will automatically release to NPM and Packagist