https://github.com/alwatr/alwatr-devkit
Alwatr is a comprehensive ecosystem designed to streamline your development process. It includes a variety of tools and libraries to help you build robust applications efficiently.
https://github.com/alwatr/alwatr-devkit
esm javascript pwa typescript
Last synced: 9 months ago
JSON representation
Alwatr is a comprehensive ecosystem designed to streamline your development process. It includes a variety of tools and libraries to help you build robust applications efficiently.
- Host: GitHub
- URL: https://github.com/alwatr/alwatr-devkit
- Owner: Alwatr
- License: agpl-3.0
- Created: 2021-12-24T17:31:50.000Z (over 4 years ago)
- Default Branch: next
- Last Pushed: 2025-01-23T10:28:14.000Z (over 1 year ago)
- Last Synced: 2025-01-27T20:54:10.903Z (over 1 year ago)
- Topics: esm, javascript, pwa, typescript
- Language: TypeScript
- Homepage:
- Size: 15.3 MB
- Stars: 25
- Watchers: 7
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Alwatr Developer Kit
The Alwatr Developer Kit is a comprehensive ecosystem designed to facilitate your development process. It comprises a diverse range of tools and libraries, empowering you to construct robust applications with enhanced efficiency.
## Introduction
Alwatr is a comprehensive ecosystem designed to streamline your development process. It includes a variety of tools and libraries to help you build robust applications efficiently.
## Installation
To install the Alwatr package, use the following command:
```sh
yarn add alwatr
```
## Usage
To use Alwatr in your project, import the necessary modules as shown below:
```typescript
import { someFunction } from 'alwatr/nanolib';
import { anotherFunction } from 'alwatr/flux';
```
## v2 Breaking Changes
- **Exports all alwatr ecosystem packages as a single `alwatr` npm package.** This significantly changes how you install and import alwatr packages.
Instead of installing individual packages like `@alwatr/resolve-url`, you now install the `alwatr` package:
```bash
npm install alwatr
```
And import modules like this:
```ts
import { resolveUrl } from 'alwatr/nanolib';
```
This change simplifies dependency management and reduces bundle size for projects using multiple alwatr packages.
### Migration Guide
1. **Uninstall individual `@alwatr/*` packages:** Use `npm uninstall @alwatr/package-name` for each alwatr package you have installed.
2. **Install the `alwatr` package:** `npm install alwatr`
3. **Update imports:** Change your import statements to use the new format, e.g., `import { resolveUrl } from 'alwatr/nanolib';`
This major release streamlines the alwatr ecosystem and improves the developer experience. Be sure to update your projects accordingly!
## Sponsors
The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
### Contributing
Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.