Skip to content

Express boilerplate with openapi, swagger, logger, versioning...

License

Notifications You must be signed in to change notification settings

X3ne/express-boilerplate

Repository files navigation

Express boilerplate

Install ans start

Clone this repo, rename .env.example to .env and add your envs

npm install

Run in dev mode

npm run dev

Run server

npm run start

Build

Just run

npm run build

Add or edit routes

Edit docs/v1.yaml and run

npm run openapiv1

to generate the files needed for api specification

Docker

envs

HOST=server host
PORT=port to start express server

API_KEY=api bearer token

Build the image

docker build . -t express-boilerplate

Run docker image

docker run --env API_KEY=token --env HOST=127.0.0.1 --env PORT=80 -p 80:80 express-boilerplate:latest

About

Express boilerplate with openapi, swagger, logger, versioning...

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published