https://github.com/spoonx/stix-wetland

🎩 A stix module that brings Wetland ORM to your project, including helpers and a criteria parser.
https://github.com/spoonx/stix-wetland

Last synced: about 2 months ago
JSON representation

🎩 A stix module that brings Wetland ORM to your project, including helpers and a criteria parser.

• Host: GitHub
• URL: https://github.com/spoonx/stix-wetland
• Owner: SpoonX
• License: mit
• Created: 2018-09-18T18:47:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T19:50:32.000Z (about 2 years ago)
• Last Synced: 2024-11-16T19:48:07.930Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 250 KB
• Stars: 2
• Watchers: 4
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![Stix wetland](./stix-wetland.svg)

[![Slack Status](https://spoonx-slack.herokuapp.com/badge.svg)](https://spoonx-slack.herokuapp.com)

A [stix](https://github.com/SpoonX/stix) module for [Wetland ORM](https://wetland.spoonx.org/).

## Setup

If you initialized a new stix project using the [boards cli stix preset](https://github.com/SpoonX/boards-preset-stix), stix-wetland will already be included in your project and you can move on to the [using section](#using). If not, keep reading.

1. In your stix project, simply run `yarn add stix-wetland`.

2. Add the module to your project's `src/config/modules.ts`:

```ts

import { ModuleManagerConfigInterface } from 'stix';

import { Wetland } from 'stix-wetland';

export const modules: ModuleManagerConfigInterface = [

  Wetland,

  // Your other modules.

];

```

### Setting up wetland

Configuring wetland can be done by adding a `wetland` key to your config.

1. Add `export * from './wetland';` to your `src/config/index.ts`.

2. Create a file at `src/config/wetland.ts` and add `export const wetland = {}` to it.

3. Configure wetland to your heart's desire.

You can find more info about the configuration options in the [wetland documentation](https://wetland.spoonx.org/configuration.html).

_**Note:** Due to the nature of stix's module system, all configs conveniently get merged. This means that you could add a `config/wetland.ts` to each of your modules specifying the `entityPaths[]` for those module's entities._

## Documentation

Take a look at the `doc/` directory to find documentation.

- [decorators](doc/decorators.md)

- [routes](doc/decorators.md)

- [config](doc/config.md)

## License

MIT.