Git Product home page Git Product logo

generator-small-api's Introduction

generator-koa-esm-api NPM version Coverage percentage

Create Koa.js API server using the modern ESM Node.js module system + Mongoose

About

This generator uses ESM modules along with webpack + pkg to build a binary. The .env file used during development will be hardcoded in the resulting binary (however, consider encrypting sensitive data, because simple strings command can reveale all of your env variables). Also this generator uses the custom Node.js loader functionality to provide custom aliasing like @/lib/email, which is resolved by webpack during the build.
NOTE: do not forget to add MONGODB_URI variable to .env file when goin prod.

Installation

First, install Yeoman and generator-koa-esm-api using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-koa-esm-api

Then generate your new project:

yo koa-esm-api

To create a new route run:

yo koa-esm-api:route name

To create a new model run:

yo koa-esm-api:model name

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

License

GPL-3.0 © Seva D.

generator-small-api's People

Contributors

vaguue avatar

Stargazers

 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.