Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akb89/noframenet-core
A set of Mongoose models and utils for handling FrameNet data on a MongoDB database
https://github.com/akb89/noframenet-core
framenet mongodb-database mongoose mongoose-model
Last synced: 13 days ago
JSON representation
A set of Mongoose models and utils for handling FrameNet data on a MongoDB database
- Host: GitHub
- URL: https://github.com/akb89/noframenet-core
- Owner: akb89
- License: mit
- Created: 2016-10-25T08:41:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-20T20:00:02.000Z (about 6 years ago)
- Last Synced: 2024-10-17T10:28:08.685Z (30 days ago)
- Topics: framenet, mongodb-database, mongoose, mongoose-model
- Language: JavaScript
- Homepage:
- Size: 63.5 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NoFrameNet-Core
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![Dependencies][david-dep-image]][david-url]
[![DevDependencies][david-dev-dep-image]][david-dev-url]
[![MIT License][license-image]][license-url]
[![FrameNet][framenet-image]][framenet-url]
A set of core Mongoose models and utils for handling FrameNet data on a MongoDB database.
_If you are looking for a solution to import FrameNet data to a MongoDB database, check out [NoFrameNet](https://github.com/akb89/noframenet)_
## Install
```shell
$ npm install --save noframenet-core
```
## Use
Using ES6 `import`
```javascript
import { Frame } from 'noframenet-core';
const frame = new Frame();
```
Using `require`
```javascript
const Frame = require('noframenet-core').Frame;
const frame = new Frame();
```
## Models
`Number` vs. `mongoose.Schema.Types.ObjectId`
- When ids are specified in FrameNet XML data, models rely on an encoded `Number` id with a unique index:
```
_id: {
type: Number,
unique: true,
}
```
- When ids are not specified in the XML data, models use the default `mongoose.Schema.Types.ObjectId` created on the fly by Mongoose and hence not encoded in the model
## FrameNet Version Compatibility
NoFrameNet-Core models are compatible with FrameNet version:
- 1.5
- 1.6
- 1.7
[npm-version-image]:https://img.shields.io/npm/v/noframenet-core.svg?style=flat-square
[npm-downloads-image]:https://img.shields.io/npm/dt/noframenet-core.svg?style=flat-square
[npm-url]:https://www.npmjs.com/package/noframenet-core
[framenet-image]:https://img.shields.io/badge/framenet-1.5%E2%87%A1-blue.svg?style=flat-square
[framenet-url]:https://framenet.icsi.berkeley.edu/fndrupal
[license-image]:http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
[license-url]:LICENSE.txt
[david-dep-image]: https://david-dm.org/akb89/noframenet-core.svg?style=flat-square
[david-url]: https://david-dm.org/akb89/noframenet-core
[david-dev-dep-image]: https://img.shields.io/david/dev/akb89/noframenet-core.svg?style=flat-square
[david-dev-url]: https://david-dm.org/akb89/noframenet-core?type=dev