express-api-bootstrap
makes it easy to create stand-alone, production-grade express based Applications that you can just run
.
# create a new directory for your app
mkdir test-boot-app
cd test-boot-app
# Generate package.json without any question
npm init -y
# add required dependencies use yarn
yarn add express-api-bootstrap
# add required dependencies use npm
npm i express-api-bootstrap --save
# init express-api-bootstrap required env
npx boot init
Open and modify package.json
with following section:
{
"scripts": {
"start": "boot dev",
"build": "boot build",
"serve": "boot serve",
"test": "boot test"
}
}
Create the first controller at src/controllers/helloController.ts
with following code:
import { HttpRequest, RestController, GetMapping } from 'express-api-bootstrap'
@RestController()
class HelloControler {
@GetMapping('/hello')
async sayHello(req: HttpRequest) {
return {
hi: req.query.name
}
}
}
export default HelloControler
Run yarn start
to, and you will see the first API at http://localhost:8080/apis/hello
see contributing