Giter Club home page Giter Club logo

node-ts-boilerplate's Introduction

Boilerplate express + typescript

๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป About this project

๐Ÿช“ Requirements

  • Docker
  • Docker Compose
  • Node 15

๐Ÿš€ Technologies

  • Typescript
  • Prisma
  • Docker

๐Ÿณ Getting Started With Docker (recomended)

  1. Clone the Repo;
  2. Install development dependencies: $ npm install
  3. Run Docker Development mode: $ docker-compose up -d
  4. Enjoy!

๐Ÿ’ป Getting Started without Docker (not recomended)

  1. Clone the Repo;
  2. Install development dependencies: $ npm install
  3. Start development server: $ npm run dev
  4. Enjoy!

โš’๏ธ Included npm scripts

Run this commands from the project folder with npm run "script-name".

  • dev: runs project in development mode
  • build: builds all .ts files from ./src folder to ./build
  • lint: lints source code using eslint
  • update: easily check for updates and update all dependencies
  • test: run tests
  • test:watch: run tests in watch mode
  • test:report: run testsa and adds report file
  • generate:module: generate an new module on node on rails modee

External typings augmentation

This starter is already configured to allow you to extend typings of external packages. The logic behind it is based on this official template. To augment a module, just create a folder with the same name as the module you are augmenting and add an index.d.ts in it. Here you can find a real world example.

๐Ÿชฐ Debugging

Warning: This starter uses new V8 inspect protocol so you have to use at least Node.js 7.7.4 if you want to use the included debugger settings.

Steps:

  • start dev server with npm run dev
  • now you have two ways:
    • use the provided debug URL in Chrome
    • use VS Code included (inside .vscode folder) attach config (best debugging experience)

Docker Support

This stater uses Node.js best practices and creates dummy user to start node process, instead of using root user.

# Go to the root of your repo created from this starter
# Build your docker image
docker build -t.

# run your docker container
docker run -p 3000:3000

node-ts-boilerplate's People

Contributors

rebonat0 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.