Code Monkey home page Code Monkey logo

node-ts-api's Introduction

node-ts-api

A very simple starter framework for an api using Node - all in Typescript.

Dev Commands

The following commands assume you have NodeJs with NPM installed and are to be executed from the project's root directory.

Set up

npm run api:install:dev

Run on dev env

npm run api:start:dev

Generate Docs

npm run api:doc

Generate API Docs

npm run api:apidoc

Lint

npm run api:lint

Test

npm run api:test

Database Commands

To be run after setting up API.

Set up Docker Images

npm run db:environment

Populate or update database

npm run db:migrate

Rollback update to database

npm run db:migrate:back

Undo then redo last update to database

npm run db:migrate:redo

Wipe database

npm run db:wipe:dev

Wipe database and run all migrations again.

npm run db:migrate:repop

Convert all current migrations into a seed

npm run db:migrate:squash

Production Commands

Set up

npm run api:install

Build

npm run api:build

Run

Install forever on the server and deploy the build there and run the following command:

npm run forever

node-ts-api's People

Contributors

dependabot[bot] avatar jamcnaughton avatar

Watchers

 avatar

node-ts-api'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.