Git Product home page Git Product logo

nodejs-koa-boilerplate's Introduction

NodeJS Koa Boilerplate

Node.js Koa Boilerplate is an project that allows you to start new node.js project from scratch.

This project uses Javascript. You can review Typescript and Flow versions.

Installation

Use these steps to install project

  1. Create Postgres databse (you can use official Docker container)
  2. Add environment variables
  3. yarn install
  4. yarn start

Usage

This boilerplate contains such folders:

  • /src - main sources folder.
  • /src/constants - app constants.
  • /src/controllers - contain controllers that receives requests from routes, executes business logic via services and returns responses to client.
  • /src/db - contain scripts to setup and manage database
  • /src/middleware - app middlewares
  • /src/entities - database entities
  • /src/services - services contains logic to manage database, execute requests to other servers, change application behabior, and etc.
  • /src/app.js - app configuration
  • /src/index.js - contain main scripts that configures and run server
  • /test - contains tests for controllers, services and other parts of application.

NPM Scripts

  • start - run dev server using nodemon
  • build - build project with babel
  • serve - run built files

Main Technologies and libraries

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

Vlad Morzhanov

License

(The MIT License)

Copyright (c) 2018 Vlad Morzhanov. You can review license in the LICENSE file.

nodejs-koa-boilerplate's People

Contributors

morzhanov avatar

Watchers

 avatar  avatar

Forkers

mernjs

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.