Git Product home page Git Product logo

koa-api-starter's Introduction

Koa API Starter Kit

A starter/boilerplate API server built on Koa 2 and BookshelfJS (SQL ORM)

Features

Initial Setup

git pull https://github.com/zlshames/koa-api-starter.git
cd koa-api-starter
cp .env.example .env                // Copy the environment file to be configured
npm install                         // Install dependencies
npm install -g knex                 // Install knex globally to use knex database migrations

Configure Database

  • Edit the .env file and enter in your database information
  • Edit the files in /migrations to whatever you want
  • For more migration information, visit: http://knexjs.org/

Database Migrations

knex migrate:latest                 // Run migration
knex migrate:rollback               // Rollback previous migration

Run the server

npm run server                      // Runs the server in development mode
npm run server:prod                 // Runs the server in prroduction mode

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.