https://github.com/therealbenpai/webutils

https://github.com/therealbenpai/webutils

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/therealbenpai/webutils
• Owner: therealbenpai
• License: gpl-3.0
• Created: 2024-04-26T13:52:12.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-06-01T19:49:43.000Z (6 months ago)
• Last Synced: 2024-11-07T16:50:41.358Z (10 days ago)
• Language: JavaScript
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Benpai Web Utilities (webutils)

## What is webutils?

webutils is a simple, minimal-dependency package that provides utilities for web development. It is designed to be a simple, easy-to-use package that provides a variety of utilities for web development.

> [!IMPORTANT]

> This package is still in development, and is not yet ready for production use. Use at your own risk.

>

> This package also lacks error handling in some areas, and may not work as expected in all cases.

>

> Future versions may include more features, and simplify the process of setting up the system.

## Installation

```bash

npm install @therealbenpai/webutils

```

## Usage

There are mutiple classes that are available to be used.

The main code is housed in [index.js](./index.js).

The type definitions are housed in [defs.d.ts](./@types/defs.d.ts).

## Contributing

To contribute to the project, do the following steps:

First, you need to install [Node.js](https://nodejs.org/) and [npm](https://npmjs.com).

To install node, run the following command:

Windows:

```powershell

# Install Git

winget install --id Git.Git -e --source winget

# Install Node.js

Set-ExecutionPolicy Bypass -Scope Process -Force;

[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;

iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'));

choco install nodejs

```

MacOS:

```bash

brew install node npm git

```

Linux:

```bash

# Ubuntu

sudo apt update

sudo apt install nodejs npm git -y

# Fedora / Red Hat

sudo dnf install nodejs npm git -y

# Arch

sudo pacman -Sy nodejs npm git

# openSUSE

sudo zypper install nodejs npm git -y

# CentOS

sudo yum install nodejs npm git -y

```

Then, clone the repository and run the following commands:

```bash

# cloning the repository

git clone "https://github.com/therealbenpai/WebUtils.git"

cd zdcors

```

In your Javascript file, simply add the following code to be able to access the package:

```javascript

const WebUtils = require('@therealbenpai/webutils');

```