Giter Club home page Giter Club logo

koa-example's Introduction

Koa example/boilerplate

This repository demonstrates the usage of Sequelize within an Koa application.

Starting App

First of all, don't forget to edit /config/config.js, create database then run:

npm install
npm start

This will start the application and create database tables. Just open http://localhost:3000.

Sequelize Setup

Now we will install all sequelize related modules.

# install ORM , CLI and SQLite dialect
npm install --save sequelize sequelize-cli mysql2

# generate models
node_modules/.bin/sequelize init
node_modules/.bin/sequelize model:generate --name User --attributes firstName:string,lastName:string,email:string

Authentication

There is several authentication strategies available. You can use which one you want and remove those you don't want.

Available strategies:

  • local
  • google
  • twitter
  • facebook

For routes you want to be accessable only by authenticated users, authenticated middleware can be used like:

router.get('/authenticated-route', authenticated(), async (ctx, next) => {
  ctx.body = 'You are logged in'
})

Authenticated middleware is in /utils/index.js

Database Relationships

For demonstrating ORM relationship, Post model created. The relationship is between users and posts like"

  Post.belongsTo(User, {as: 'Author'})

You can find examples of relationship when creating new post, which each post will be associated to a user and also in route /posts/user-posts/ which gets all posts of logged in user.

koa-example's People

Contributors

andrewmartynyshyn avatar bdombro avatar dependabot[bot] avatar foadyousefi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  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.