Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shihabmridha committed Jun 26, 2023
1 parent b365a1e commit 71115fd
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# Repository pattern & Dependency injection using TypeScript

### !! Work in progress

# Repository pattern & Dependency injection using TypeScript

This starter kit tries to implement a NodeJS, ExpressJS and MongoDB powered web application using repository pattern and dependency injection. The main idea is independent of any framework or database. TypeScript is used instead of JavaScript for various reasons. Especially the support for interface, generic type support, and better IntelliSense.

# Usage
- Install TypeScript globally (`npm i -g typescript`)
- Install required modules (`npm install`)
- Compile typescript to javascript (`npm run compile`)
- Compile typescript (`npm run build`)
- Run (`npm start`)
- Go to `http://localhost:3000`. You should see a static html page.

Note: For development open two terminals. Run `npm run build:watch` in one terminal and run `npm run dev` in another one. This will allow you do hot-reload.

# Core Features
- Dependency injection
- Repository pattern
Expand Down

0 comments on commit 71115fd

Please sign in to comment.