alexweber / gizmo-express

Express + Typescript

Gizmo Express

An opinionated Express REST API starter using Typescript and Mongoose.

Overview

• 100% Typescript
• Express 4 REST API server boilerplate
• Built for an Angular 2+ backend
• Simple and easy to work with
• Comprehensive test-suite with 150+ tests and >85% code coverage (and counting)

Features

• Smart config management
• Dynamic CRUD routes for arbitrary resources
• Convenient but powerful sanitizer
• Robust acl (in progress)
• Powerful caching with apicache and optional Redis support
• Data seeding (in progress)
• Sane rate limiting (in progress)

Install/Run

1. Make sure Yarn is installednpm install -g yarn or follow the install instructions
2. Run yarn to install dependencies
3. Run one of:
   • yarn start to run in production
   • yarn dev to start a local dev server
   • yarn test to run tests
   • yarn lint to lint code

Caveats

• Waiting on Angular 4 Universal updates before actually integrating it
• Typescript compilation into /dist/src and /dist/test is fugly, maybe Angular 4 CLI will have a solution?
• Not actually used in production yet, TDD all the way