Giter Club home page Giter Club logo

express-template's Introduction

Node.JS Express Template with Mikro-ORM

Main dependent Library

  • mikro-orm for persistance layer and documentation
  • tsoa for presentation layer
  • module-alias to manage modules
  • jest for unit test
  • supertest for e2e test

Run Application

Run and configure application

  • Create and configure .env file for local environment
    • To run with sqlite, please refer .env.test file
    • To run with mysql, check mysql service is running and configure like .env.dev file
  • All configurations for Database are applied in file repo-context.ts
  • Now app can be run with below command
npm run dev:start

Migrate Database

  • Migration is triggered in index.ts or global-suite.ts files
  • Sqlite migration files are always created with initialized option and won't be saved
  • With MySQL, migration file must be created manually, When definetion of entities or decorators are changed
# Only at first time
npx mikro-orm migration:create --initial

npx mikro-orm migration:create

Routers

Note
routes.ts, swagger.json files are generaged with tsoa library.
When files aren't generaged, app.ts file would errors.
For example when just download this project.
Then build or generate with commands npm run build or npm run routes

express-template's People

Contributors

lazyskulptor avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

express-template's Issues

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.