forked from sequelize/sequelize
-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
74 lines (74 loc) · 6.96 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
{
"name": "sequelize",
"description": "Multi dialect ORM for Node.JS",
"version": "1.6.0-beta4",
"author": {
"name": "Sascha Depold",
"email": "[email protected]"
},
"contributors": [
{
"name": "Sascha Depold",
"email": "[email protected]"
},
{
"name": "Meg Sharkey",
"email": "[email protected]"
},
{
"name": "Chase Geigle",
"email": "[email protected]"
},
{
"name": "Jan Aagaard Meier",
"email": "[email protected]",
"url": "Innofluence"
}
],
"dependencies": {
"mysql": "~2.0.0-alpha3",
"underscore": "~1.4.0",
"underscore.string": "~2.3.0",
"lingo": "~0.0.5",
"validator": "0.3.x",
"moment": "~1.7.0",
"commander": "~0.6.0",
"generic-pool": "1.0.9"
},
"devDependencies": {
"jasmine-node": "1.0.17",
"sqlite3": "~2.1.5",
"pg": "~0.8.7",
"buster": "~0.6.0",
"dox-foundation": "~0.3.0"
},
"keywords": [
"mysql",
"orm",
"nodejs",
"object relational mapper"
],
"main": "index",
"scripts": {
"test": "npm run test-jasmine && npm run test-buster",
"test-jasmine": "./node_modules/.bin/jasmine-node spec-jasmine/",
"test-buster": "npm run test-buster-mysql && npm run test-buster-postgres && npm run test-buster-postgres-native && npm run test-buster-sqlite",
"test-buster-travis": "./node_modules/.bin/buster-test",
"test-buster-mysql": "DIALECT=mysql ./node_modules/.bin/buster-test",
"test-buster-postgres": "DIALECT=postgres ./node_modules/.bin/buster-test",
"test-buster-postgres-native": "DIALECT=postgres-native ./node_modules/.bin/buster-test",
"test-buster-sqlite": "DIALECT=sqlite ./node_modules/.bin/buster-test",
"generate-docs": "node_modules/.bin/dox-foundation --source ./lib --title Sequelize"
},
"bin": {
"sequelize": "bin/sequelize"
},
"engines": {
"node": ">=0.4.6"
},
"license": "MIT",
"readme": "# Sequelize #\n\nThe Sequelize library provides easy access to MySQL, SQLite or PostgreSQL databases by mapping database entries to objects and vice versa. To put it in a nutshell... it's an ORM (Object-Relational-Mapper). The library is written entirely in JavaScript and can be used in the Node.JS environment.\n\n## Blogposts/Changes ##\n- [v1.4.1](http://blog.sequelizejs.com/post/24403298792/changes-in-sequelize-1-4-1): deprecation of node < 0.6, logging customization, ...\n- [v1.4.0](http://blog.sequelizejs.com/post/24345409723/changes-in-sequelize-1-4-0): postgresql, connection pooling, ...\n- [v1.3.0](http://blog.depold.com/post/15283366633/changes-in-sequelize-1-3-0): migrations, cross-database, validations, new listener notation, ...\n- [v1.2.1](http://blog.depold.com/post/12319530694/changes-in-sequelize-1-2-1): changes some defaults and some interfaces\n- [v1.0.0](http://blog.depold.com/post/5936116582/changes-in-sequelize-1-0-0): complete rewrite\n\n## Features ##\n\n- Schema definition\n- Schema synchronization/dropping\n- Easy definition of class/instance methods\n- Instance saving/updating/dropping\n- Asynchronous library\n- Associations\n- Importing definitions from single files\n\n## Documentation, Examples and Updates ##\n\nYou can find the documentation and announcements of updates on the [project's website](http://www.sequelizejs.com).\nIf you want to know about latest development and releases, follow me on [Twitter](http://twitter.com/sdepold).\nAlso make sure to take a look at the examples in the repository. The website will contain them soon, as well.\n\n- [Documentation](http://www.sequelizejs.com)\n- [Twitter](http://twitter.com/sdepold)\n- [IRC](irc://irc.freenode.net/sequelizejs)\n- [XING](https://www.xing.com/net/priec1b5cx/sequelize)\n\n## Collaboration 2.0 ##\n\nI'm glad to get pull request if any functionality is missing or something is buggy. But _please_ ... run the tests before you send me the pull request.\n\nStill interested? Coolio! Here is how to get started:\n\n### 1. Prepare your environment ###\n\nHere comes a little surprise: You need [Node.JS](http://nodejs.org). In order to be\na productive developer, I would recommend the latest v0.8 (or a stable 0.9 if\nalready out). Also I usually recommend [NVM](https://github.com/creationix/nvm).\n\nOnce Node.JS is installed on your computer, you will also have access to the lovely\nNode Package Manager (NPM).\n\n### 2. Database... Come to me! ###\n\nFirst class citizen of Sequelize was MySQL. Over time, Sequelize began to\nbecome compatible to SQLite and PostgreSQL. In order to provide a fully\nfeatured pull request, you would most likely want to install of them. Give\nit a try, it's not that hard.\n\nIf you are too lazy or just don't know how to get this work,\nfeel free to join the IRC channel (freenode@#sequelizejs).\n\nFor MySQL and PostgreSQL you'll need to create a DB called `sequelize_test`.\nFor MySQL this would look like this:\n\n```console\n$ echo \"CREATE DATABASE sequelize_test;\" | mysql -uroot\n```\n\n**CLEVER NOTE:** your local MySQL install must be with username `root`\n without password. If you want to customize that just hack in the\n tests, but make sure to don't commit your credentials, we don't want\n to expose your personal data in sequelize codebase ;)\n\n**AND ONE LAST THING:** Once `npm install` worked for you (see below), you'll\nget SQLite tests for free :)\n\n\n### 3. Install the dependencies ###\n\nJust \"cd\" into sequelize directory and run `npm install`, see an example below:\n\n```console\n$ cd path/to/sequelize\n$ npm install\n```\n\n### 4. Run the tests ###\n\nRight now, the test base is split into the `spec` folder (which contains the\nlovely [BusterJS](http://busterjs.org) tests) and the `spec-jasmine` folder\n(which contains the ugly and awkward node-jasmine based tests). A main goal\nis to get rid of the jasmine tests!\n\nAs you might haven't installed all of the supported SQL dialects, here is how\nto run the test suites for your development environment:\n\n```console\n$ # run all tests at once:\n$ npm test\n\n$ # run only the jasmine tests (for all dialects):\n$ npm run test-jasmine\n\n$ # run all of the buster specs (for all dialects):\n$ npm run test-buster\n\n$ # run the buster specs for mysql:\n$ npm run test-buster-mysql\n\n$ # run the buster specs for sqlite:\n$ npm run test-buster-sqlite\n\n$ # run the buster specs for postgresql:\n$ npm run test-buster-postgres\n```\n\n### 5. That's all ###\n\nJust commit and send pull requests.\nHappy hacking and thank you for contributing.\nAh and one last thing: If you think you deserve it, feel free to add yourself to the\n`package.json`. Also I always look for projects which are using sequelize. If you have\none of them, drop me a line!\n\n\n# Build status\n\nThe automated tests we talk about just so much are running on\n[Travis public CI](http://travis-ci.org), here is its status:\n\n[![Build Status](https://secure.travis-ci.org/sdepold/sequelize.png)](http://travis-ci.org/sdepold/sequelize)\n",
"readmeFilename": "README.md",
"_id": "[email protected]",
"_from": "[email protected]"
}