Code Monkey home page Code Monkey logo

simpleapp's Introduction

# Express Example This repository demonstrates the usage of Sequelize within an [Express](https://expressjs.com) application. The implemented logic is a simple task tracking tool. [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) ## Starting App **Without Migrations** ``` npm install npm start ``` **With Migrations** ``` npm install node_modules/.bin/sequelize db:migrate npm start ``` This will start the application and create an sqlite database in your app dir. Just open [http://localhost:3000](http://localhost:3000). ## Running Tests We have added some [Mocha](https://mochajs.org) based test. You can run them by `npm test` ## Setup in Details In order to understand how this application has been built, you can find the executed steps in the following snippet. You should be able to adjust those steps according to your needs. Please note that the view and the routes aren't described. You can find those files in the repo. #### Express Setup First we will create a bare Express App using `express-generator` [Express Generator](https://expressjs.com/en/starter/generator.html) ```bash # install express generator globally npm install -g express-generator # create the sample app express express-example cd express-example # install all node modules npm install ``` #### Sequelize Setup Now we will install all sequelize related modules. ```bash # install ORM , CLI and SQLite dialect npm install sequelize sequelize-cli sqlite3 # generate models node_modules/.bin/sequelize init node_modules/.bin/sequelize model:create --name User --attributes username:string node_modules/.bin/sequelize model:create --name Task --attributes title:string ``` We are using `.sequelizerc` setup change config path for migrations. You can read more about this in [migration docs](http://docs.sequelizejs.com/manual/tutorial/migrations.html#the-sequelizerc-file) ```js // .sequelizerc const path = require('path'); module.exports = { 'config': path.resolve('config', 'config.js') } ``` You will now have a basic express application with some additional directories (config, models, migrations). Also you will find two migrations and models. One for the `User` and one for the `Task`. In order to associate the models with each other, you need to change the models like this: ```js // task.js // ... Task.associate = function(models) { // Using additional options like CASCADE etc for demonstration // Can also simply do Task.belongsTo(models.User); Task.belongsTo(models.User, { onDelete: "CASCADE", foreignKey: { allowNull: false } }); } // ... ``` ```js // user.js // ... User.associate = function(models) { User.hasMany(models.Task); } // ... ``` This association will create an attribute `UserId` in `Task` model. We have to amend our `create-task` migration and add this column. ```js // xxxxxxx-create-task.js // ... UserId: { type: Sequelize.INTEGER, onDelete: "CASCADE", allowNull: false, references: { model: 'Users', key: 'id' } } // ... ``` If you want to use the automatic table creation that sequelize provides, you have to adjust the `bin/www` file to this: ```js #!/usr/bin/env node var app = require('../app'); var debug = require('debug')('init:server'); var http = require('http'); var models = require("../models"); var port = normalizePort(process.env.PORT || '3000'); app.set('port', port); var server = http.createServer(app); // sync() will create all table if they doesn't exist in database models.sequelize.sync().then(function () { server.listen(port); server.on('error', onError); server.on('listening', onListening); }); function normalizePort(val) { /* ... */ } function onError(error) { /* ... */ } function onListening() { /* ... */ } ``` And finally you have to adjust the `config/config.js` to fit your environment. Once thats done, your database configuration is ready! # SimpleApp

simpleapp's People

Contributors

sanmi01 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.