Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.52 KB

README.md

File metadata and controls

62 lines (41 loc) · 2.52 KB

Codacy Badge License Build Status Black Duck Security Risk Average time to resolve an issue Percentage of issues still open Gitter chat PRs Welcome

Express (Typescript) Rest API Starter

Boilerplate project for bootstrapping development of a Rest API application with Express using Typescript as the programming language.

Getting Started

Clone the repository

git clone https://github.com/spinsage/express-typescript-starter-rest.git

Install dependencies

npm install

Configure environment variables

  • Create a .env file by copying .env.sample.
  • Update environment variable values in the .env file as needed.

Run the application

For development

npm run dev

For deployment

npm run build
npm run start

Within a Docker container

docker-compose up

LICENSE

Express Rest API Starter is Apache 2-licensed.

Let us know!

We at Spinsage would be happy if you send us links to your projects where you are using our code. Just send us an email at [email protected].

And do let us know if you have any queries or suggestions regarding our work.