https://github.com/hyperifyio/io.hyperify.mysql
Hyperify git module for MySQL related TypeScript
https://github.com/hyperifyio/io.hyperify.mysql
Last synced: 8 days ago
JSON representation
Hyperify git module for MySQL related TypeScript
- Host: GitHub
- URL: https://github.com/hyperifyio/io.hyperify.mysql
- Owner: hyperifyio
- License: other
- Created: 2023-12-11T21:12:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T09:40:49.000Z (over 1 year ago)
- Last Synced: 2024-09-09T17:36:09.005Z (over 1 year ago)
- Language: TypeScript
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
**Join our [Discord](https://discord.gg/UBTrHxA78f) to discuss about our software!**
# @heusalagroup/fi.hg.mysql
Lightweight MySQL persister written in TypeScript.
To use this persister, install following dependencies:
```
npm install --save mysql @types/mysql
```
See also [hgrs](https://github.com/heusalagroup/hgrs).
### It doesn't have many runtime dependencies
This library expects [@heusalagroup/fi.hg.core](https://github.com/heusalagroup/fi.hg.core) to be located
in the relative path `../core` and only required dependency it has is for [Lodash
library](https://lodash.com/).
### We don't have traditional releases
This project evolves directly to our git repository in an agile manner.
This git repository contains only the source code for compile time use case. It is meant to be used
as a git submodule in a NodeJS or webpack project.
Recommended way to initialize your project is like this:
```
mkdir -p src/fi/hg
git submodule add git@github.com:heusalagroup/fi.hg.core.git src/fi/hg/core
git config -f .gitmodules submodule.src/fi/hg/core.branch main
git submodule add git@github.com:heusalagroup/fi.hg.mysql.git src/fi/hg/mysql
git config -f .gitmodules submodule.src/fi/hg/mysql.branch main
```
Other required dependencies are [the Lodash library](https://lodash.com/) and [mysql](https://github.com/mysqljs/mysql):
```
npm install --save-dev lodash @types/lodash mysql @types/mysql
```
### License
Copyright (c) Heusala Group Ltd. All rights reserved.
Each software release is initially under the HG Evaluation and
Non-Commercial License for the first two years. This allows use, modification,
and distribution for non-commercial and evaluation purposes only. Post this
period, the license transitions to the standard MIT license, permitting broader
usage, including commercial applications. For full details, refer to the
[LICENSE.md](LICENSE.md) file.
**Commercial usage licenses can be obtained under separate agreements.**