Git Product home page Git Product logo

nodejs-boilerplate's Introduction

try! resty.js, my newest node.js + express based framework. with controllers and middlewares built in.

nodejs-boilerplate

Clean Architecture for node.js projects

Folder Structure

src
│   main.ts         # Application entry point
└───api             # Express route controllers for all the endpoints of the app
└───config          # Environment variables and configurations
└───loaders         # Split the startup process into modules
└───models          # TypeORM Entities
└───services        # All the business logic is here
└───types           # Type declaration files (d.ts) for Typescript

Getting Started

Step 1: Set up the Development Environment

You need to set up your development environment before you can do anything.

Install Node.js and NPM

Install

  • Install all dependencies with yarn install

Running in dev mode

  • Run yarn start
  • The server address will be displayed to you as http://0.0.0.0:3000

Building the project and run it

  • Run yarn build to generated all JavaScript files from the TypeScript sources.
  • the builded app located in dist.

Inspired by Bulletproof Node.js architecture with modificatins

nodejs-boilerplate's People

Contributors

satishbabariya avatar dependabot-preview[bot] avatar renovate-bot avatar akbar1214 avatar renovate[bot] 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.