Skip to content

Commit

Permalink
Update: dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
ianwieds committed Jun 19, 2024
1 parent 13074ec commit 732941a
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 33 deletions.
5 changes: 5 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.codeclimate.yml
/src/
/test/
/examples/
/old/
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# CHANGELOG

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## Changelog Categories

- `BREAKING` for breaking changes.
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

---
## [1.0.0] - 2024-06-19
### Added
- Initial release of the project 🚀
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg">
<a href="https://itwcreativeworks.com">
<img src="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" width="100px">
</a>
</p>
Expand Down Expand Up @@ -28,26 +28,26 @@
This module is best used when bundled with <a href="https://www.npmjs.com/package/webpack">webpack</a>.
</p>

## Install
## 📦 Install Web Manager
Install with npm:
```shell
npm install web-manager
```

## Features
## 🦄 Features
* Polyfill detection and implementation for Promises, Array methods, window.fetch, and more!
* Dom API that acts as a super lightweight and optimized version of jQuery
* Improved Localstorage API
* Utility API with the most useful Lodash methods `get` and `set`

## Libraries
## 📚 Libraries
* Firebase (Firebase app, Firestore, Auth, & Messaging)
* Lazysizes to lazyload images
* Sentry to report errors
* [Chatsy.ai](https://chatsy.ai) AI chatbot integration
* Cookieconsent to comply with GDPR

## Example Setup
## 📘 Example Setup
After installing via npm, simply paste this script before the closing `</body>` tag to initialize Web Manager.
```html
<script type="text/javascript">
Expand All @@ -61,7 +61,7 @@ After installing via npm, simply paste this script before the closing `</body>`
</script>
```

## Example Usage
## 📘 Example Usage
Lets go over some example usage of the library.

### Kitchen Sink Config example
Expand All @@ -75,7 +75,7 @@ By default, all of the libraries are enabled. But you can simply set `enabled` t
},
serviceWorker: {
path: 'firebase-messaging-sw.js' // Path to your service worker
},
},
libraries: {
firebase_app: { // Config is required if enabled
enabled: true,
Expand All @@ -88,7 +88,7 @@ By default, all of the libraries are enabled. But you can simply set `enabled` t
messagingSenderId: '123456',
appId: '1:xxx'
}
},
},
tawk: { // Config is required if enabled
enabled: true,
config: {
Expand Down Expand Up @@ -128,7 +128,7 @@ By default, all of the libraries are enabled. But you can simply set `enabled` t
},
lazysizes: { // No config required
enabled: true
}
}
}
}
var Manager = new (require('web-manager'));
Expand Down Expand Up @@ -212,7 +212,7 @@ The Web Manager .utilities() API wraps some useful functions such as getting and
```html
<script type="text/javascript">
console.log('--- Exploring the .utilities() API ---');
// .get() and .set()
Manager.ready(function() {
var object = {
Expand Down Expand Up @@ -241,7 +241,7 @@ The Web Manager .utilities() API wraps some useful functions such as getting and
Manager.utilities().clipboardCopy('I am copied to the clipboard!')
// .escapeHTML()
Manager.utilities().escapeHTML('<strong>This will will NOT render as bold!</strong>')
Manager.utilities().escapeHTML('<strong>This will will NOT render as bold!</strong>')
</script>
```

Expand Down Expand Up @@ -390,11 +390,11 @@ To preserve file size and enforce optimization, the `.account()` library must be



## Final Words
## 🗨️ Final Words
If you are still having difficulty, we would love for you to post
a question to [the Web Manager issues page](https://github.com/itw-creative-works/web-manager/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)

## Projects Using this Library
## 📚 Projects Using this Library
[Somiibo](https://somiibo.com/): A Social Media Bot with an open-source module library. <br>
[JekyllUp](https://jekyllup.com/): A website devoted to sharing the best Jekyll themes. <br>
[Slapform](https://slapform.com/): A backend processor for your HTML forms on static sites. <br>
Expand Down
55 changes: 41 additions & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 14 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
{
"name": "web-manager",
"version": "3.2.50",
"version": "3.2.51",
"description": "Easily access important variables such as the query string, current domain, and current page in a single object.",
"main": "index.js",
"scripts": {
"test": "./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
"test_": "npm run prepare && ./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
"prepare_": "node -e 'require(`prepare-package`)()'"
"prepare_": "node -e 'require(`prepare-package`)()'",
"prepare": "node -e \"require('prepare-package')()\"",
"prepare:watch": "nodemon -w ./src -e '*' --exec 'npm run prepare'"
},
"engines": {
"node": ">=6.0.0"
"node": ">=12"
},
"repository": {
"type": "git",
Expand All @@ -32,15 +34,21 @@
"lazysizes": "^5.3.2"
}
},
"preparePackage": {
"input": "./src",
"output": "./dist",
"replace": {}
},
"dependencies": {
"@sentry/browser": "^7.117.0",
"cookieconsent": "^3.1.1",
"firebase": "^9.23.0",
"itwcw-package-analytics": "^1.0.1",
"itwcw-package-analytics": "^1.0.4",
"lazysizes": "^5.3.2"
},
"devDependencies": {
"lodash": "^4.17.21",
"mocha": "^8.4.0"
"mocha": "^8.4.0",
"prepare-package": "^1.1.12"
}
}
}

0 comments on commit 732941a

Please sign in to comment.