Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/satishbabariya/nodejs-boilerplate
Clean Architecture for node.js projects (Typescript + Express + TypeORM + Typedi)
https://github.com/satishbabariya/nodejs-boilerplate
boilerplate dependency-injection dependency-injection-container express hacktoberfest injection-container inversifyjs inversion-of-control mongodb mysql node nodejs orm posgresql typedi typeorm typescript
Last synced: 5 days ago
JSON representation
Clean Architecture for node.js projects (Typescript + Express + TypeORM + Typedi)
- Host: GitHub
- URL: https://github.com/satishbabariya/nodejs-boilerplate
- Owner: satishbabariya
- License: mit
- Created: 2019-05-20T15:41:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-26T19:38:56.000Z (11 months ago)
- Last Synced: 2024-12-18T23:06:38.035Z (12 days ago)
- Topics: boilerplate, dependency-injection, dependency-injection-container, express, hacktoberfest, injection-container, inversifyjs, inversion-of-control, mongodb, mysql, node, nodejs, orm, posgresql, typedi, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 1.39 MB
- Stars: 391
- Watchers: 5
- Forks: 59
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
try! [resty.js](https://github.com/restyjs/resty), 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](https://nodejs.org/en/download/)
- on OSX use [homebrew](http://brew.sh) `brew install node`
- on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
### 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