https://github.com/bitwit/typescript-express-api-template
[WIP] Template for an Express API written in TypeScript
https://github.com/bitwit/typescript-express-api-template
Last synced: 11 months ago
JSON representation
[WIP] Template for an Express API written in TypeScript
- Host: GitHub
- URL: https://github.com/bitwit/typescript-express-api-template
- Owner: bitwit
- Created: 2018-04-02T06:01:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T01:46:48.000Z (over 3 years ago)
- Last Synced: 2025-04-23T22:52:28.073Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.22 MB
- Stars: 18
- Watchers: 0
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Typescript Web Application Template
Work in progress template for cloning to rapidly build new APIs
## Instructions
1. Get Docker
2. `$ docker-compose up`
## Goals
The intention of this application is to help with two key things
1. To bootstrap an application with most of the mundane REST API work done already
2. Structure / Best practices solidified
## Capabilities out of the box
- Express server powered using TypeScript friendly `routing-controllers` and `type-orm`
- All the boring user management boilerplate
- Server side rendering of React TSX files, including email
- Automatic Swagger docs generation generated from `routing-controllers` decorators and return types
- E2E tests for all boilerplated API
- Fixtures for e2e testing
## To-dos
- User CRUD
- Email confirmation status
- User creation via email reset flow (i.e. confirmation)
- Device Authorization via email
- Proper Prod/Staging environment settings for both building and running
- Docs generation for prod build flow only, or on demand
- Robust config file
- Include detail oriented things such as (these are at least needed for Apple Apps, so they should be on the checklist):
- Url to Terms and Conditions
- Url Privacy Policy
- Todo Management
- CRUD Todo List
- CRUD Todo List Item
- Static assets docker image
- Basic Single Page Application
### Nice to have
- iOS Push Notification support
- Google OAuth Signup
- Facebook OAuth Signup
- Twitter OAuth Signup
- Redis Cache Layer