@osaedasia/oresume/README.md

A user-friendly library for generating complete Single Page Applications (SPAs)

# Oresume

A library designed to generate Single Page Application (SPA).

The library is available through the following package managers:

- [npm](https://www.npmjs.com/package/@osaedasia/oresume)

To create a new project, use this command:

```shell
npx create-oresume-app@latest [project-name]
```

For mode details on the command [create-oresume-app](https://www.npmjs.com/package/create-oresume-app).

## Features

- **Application Management:** Centralized app instance with routing capabilities
- **Component System:** Fragment-based component architecture
- **Infrastructure Tools:**
    - Observable state management
    - Theme system
    - Language service
    - Resource management (Public folder and Localized inner code resource)
    - HTML parsing utilities
    - Task management system
- **Built-in Types:** Comprehensive TypeScript definitions for all features
- **Plugin System:** Extensible with plugins (e.g., OresumeCSSPlugin)

---

### **To learn how to use this library, visit the project's GitLab repository for demonstrations of all available
features!**

repository: https://gitlab.com/osaedasia/public/npm-packages/oresume/-/tree/main/test

---

## Reporting Issues

If you encounter any issues while using the library, feel free to report them by creating an issue on
the [GitLab repository](https://gitlab.com/osaedasia/public/npm-packages/oresume). Since we maintain this package,
please provide as much detail as possible to help resolve the issue efficiently. Make sure to include:

- **Clear description** of the problem
- **Steps to reproduce** the issue
- **Library version**
- Relevant information such as:
    - **Stack trace**
    - `Environment details` (e.g., operating system, Node.js version, etc.)
    - `Code snippets` where the issue occurs

Your detailed feedback is crucial in improving the library for everyone.

## LICENCE

```text
MIT License

Copyright (c) 2024 Osaedasia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```