A Database Modeler for Node; designed to help you produce easy-to-read, maintainable code.
The goal of this project is not to be everything to everyone. It is not meant to solve every possible edge case. Instead, it is focused on the most common use cases for data-driven applications. That being said, take a gander at the Documentation to see if sequel will fit your application's needs.
Sequel currently works with the following databases:
Add to your application via
npm install sequel --save
This will install
sequel and add it to your application's
Sequel does not have a database driver as a dependency, so you must install one separately from sequel.
If you are using MySQL, and have not already installed the
mysql package, you can install it with the following:
npm install mysql --save
If you are using SQLite, and have not already installed the
sqlite3 package, you can install it with the following:
npm install sqlite3 --save
There are a number of ways you can contribute:
readme.mdfile. If you see a mistake, or think something should be clarified or expanded upon, please submit a pull request
Before you contribute code, please read through at least some of the source code for the project. I would appreciate it if any pull requests for source code changes follow the coding style of the rest of the project.
Now if you're still interested, you'll need to get your local environment configured.
First, you'll need to pull down the code from GitHub:
git clone firstname.lastname@example.org:chill117/sequel.git
Second, you'll need to install the project dependencies as well as the dev dependencies. To do this, simply run the following from the directory you created in step 1:
Now, you'll need to set up local test databases for each database driver:
mysql:host: 'localhost'port: 3306user: 'sequel_test'password: 'password'database: 'sequel_test'driver: 'mysql'sqlite:filename: ':memory:'driver: 'sqlite'
These database credentials are located at
To run all tests:
To run all MySQL tests:
To run all SQLite tests:
If you don't have
grunt-cli installed globally, you can run tests with
grunt like this instead:
The above should be run from within the
sequel project directory.