Initial commit

Author: Pascal Iske

.editorconfig

@@ -0,0 +1,16 @@
+# top-most editorconfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[.*rc]
+indent_size = 2
+
+[*.{yml,json,lock}]
+indent_size = 2

.gitignore

@@ -0,0 +1,17 @@
+# compiled output
+dist
+
+# orm config
+ormconfig.json
+
+# dependencies
+node_modules
+
+# misc
+typings
+npm-debug.log
+yarn-error.log
+
+# system files
+.DS_Store
+Thumbs.db

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "printWidth": 100,
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 4,
+  "trailingComma": "all"
+}

.travis.yml

@@ -0,0 +1,11 @@
+language: node_js
+node_js:
+  - '8'
+  - '9'
+  - '10'
+install:
+  - yarn install
+  - yarn run build
+script:
+  - yarn run lint
+  - yarn run test

README.md

@@ -0,0 +1,84 @@
+# TypeScript API Skeleton
+
+## Setup
+
+To install the skeleton use the following commands:
+
+```bash
+$ mkdir -p my-api
+$ cd my-api
+$ git clone https://github.com/pascaliske/typescript-api.git .
+$ yarn install
+```
+
+## Development
+
+Start the server using this command:
+
+```bash
+$ yarn run start
+```
+
+For using the built in file watch you can also start the server using this command:
+
+```bash
+$ yarn run watch
+```
+
+To execute the tests run this command:
+
+```bash
+$ yarn run test
+```
+
+### Controllers
+
+You can write controllers the following way:
+
+```typescript
+import { Service } from 'typedi'
+import { JsonController, Get } from 'routing-controllers'
+
+/**
+ * Creates the controller as an dependency injected service
+ */
+@Service()
+@JsonController('/status')
+export class UserController {
+    /**
+     * Defines an endpoint for "GET /api/status"
+     */
+    @Get('/')
+    public async createUser() {
+        return 'success'
+    }
+}
+```
+
+### Tests
+
+You can write controllers the following way:
+
+```typescript
+import test from 'ava'
+import { factory } from '../../index.test'
+
+test('GET /', async t => {
+    // this one is important for usage with supertest
+    t.plan(2)
+
+    // creates a server instance for access with supertest lib
+    const server = await factory()
+    const response = await server.get('/api/status')
+
+    t.is(response.status, 200)
+    t.deepEqual(response.body, {
+        data: 'success',
+        status: 200,
+    })
+})
+```
+
+## License
+
+MIT © [Pascal Iske](https://pascal-iske.de)

ormconfig.json.dist

@@ -0,0 +1,20 @@
+{
+  "name": "default",
+  "type": "mysql",
+  "host": "127.0.0.1",
+  "port": 3306,
+  "username": "DBUSER",
+  "password": "DBPASS}",
+  "database": "travelfeed_api",
+  "synchronize": true,
+  "logging": false,
+  "entities": [
+    "dist/modules/*/models/*.js"
+  ],
+  "migrations": [
+    "dist/migrations/*.js"
+  ],
+  "cli": {
+    "migrationsDir": "src/migrations"
+  }
+}

package.json

@@ -0,0 +1,79 @@
+{
+  "name": "typescript-api",
+  "description": "Skeleton project for easy extendable TypeScript APIs.",
+  "version": "0.0.0",
+  "author": {
+    "name": "Pascal Iske",
+    "email": "info@pascal-iske.de",
+    "url": "https://pascal-iske.de"
+  },
+  "license": "MIT",
+  "scripts": {
+    "start": "node dist/index.js",
+    "build": "tsc -p tsconfig.json",
+    "watch": "nodemon --exec \"yarn run build && yarn run start\" --watch src --ext ts",
+    "lint": "tslint -p tsconfig.json --fix",
+    "test": "ava dist/**/*.test.js",
+    "format": "prettier --write \"**/*.{ts,md}\"",
+    "precommit": "lint-staged"
+  },
+  "repository": {
+    "url": "https://github.com/pascaliske/typescript-api.git",
+    "type": "git"
+  },
+  "bugs": {
+    "url": "https://github.com/pascaliske/typescript-api/issues"
+  },
+  "private": true,
+  "lint-staged": {
+    "**/*.md": [
+      "prettier --write",
+      "git add"
+    ],
+    "**/*.ts": [
+      "tslint -p tsconfig.json --fix",
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "dependencies": {
+    "compression": "^1.7.2",
+    "config": "^1.30.0",
+    "cors": "^2.8.4",
+    "express": "^4.16.3",
+    "helmet": "^3.12.1",
+    "morgan": "^1.9.0",
+    "mysql": "^2.15.0",
+    "nodemon": "^1.17.5",
+    "routing-controllers": "^0.7.7",
+    "socket-controllers": "^0.0.3",
+    "socket.io": "^2.1.1",
+    "typedi": "^0.7.3",
+    "typeorm": "^0.2.7",
+    "typeorm-routing-controllers-extensions": "^0.2.0",
+    "typeorm-typedi-extensions": "^0.2.1",
+    "winston": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/body-parser": "^1.17.0",
+    "@types/compression": "^0.0.36",
+    "@types/config": "^0.0.34",
+    "@types/cors": "^2.8.4",
+    "@types/express": "^4.16.0",
+    "@types/helmet": "^0.0.38",
+    "@types/morgan": "^1.7.35",
+    "@types/node": "^10.3.4",
+    "@types/socket.io": "^1.4.36",
+    "@types/supertest": "^2.0.4",
+    "ava": "^0.25.0",
+    "husky": "^0.14.3",
+    "lint-staged": "^7.2.0",
+    "prettier": "^1.13.5",
+    "reflect-metadata": "^0.1.12",
+    "supertest": "^3.1.0",
+    "tslint": "^5.10.0",
+    "tslint-config-prettier": "^1.13.0",
+    "typedoc": "^0.11.1",
+    "typescript": "^2.9.2"
+  }
+}

src/index.test.ts

@@ -0,0 +1,35 @@
+import 'reflect-metadata'
+import test from 'ava'
+import * as supertest from 'supertest'
+import { Container } from 'typedi'
+import { useContainer as useContainerDatabase, createConnection } from 'typeorm'
+import { useContainer as useContainerRouting } from 'routing-controllers'
+import { useContainer as useContainerSocket } from 'socket-controllers'
+import { Server } from './server'
+
+/**
+ * Mock database connection and prepare server.
+ */
+export async function factory(): Promise<supertest.SuperTest<supertest.Test>> {
+    useContainerDatabase(Container)
+    useContainerRouting(Container)
+    useContainerSocket(Container)
+
+    const server = Container.get(Server)
+
+    await createConnection()
+    await server.prepare(process.env.NODE_ENV || 'development')
+
+    return supertest(server.App)
+}
+
+/**
+ * Inject server instance in each test context.
+ */
+test.beforeEach(async () => {
+    // setup test context
+})
+
+test('init', async t => {
+    t.pass()
+})

src/index.ts

@@ -0,0 +1,22 @@
+import 'reflect-metadata'
+import { Container } from 'typedi'
+import { useContainer as useContainerDatabase, createConnection } from 'typeorm'
+import { useContainer as useContainerRouting } from 'routing-controllers'
+import { useContainer as useContainerSocket } from 'socket-controllers'
+import { Server } from './server'
+
+// enable di on 3rd party libraries
+useContainerDatabase(Container)
+useContainerRouting(Container)
+useContainerSocket(Container)
+
+// fetch port and server instance
+const env = process.env.NODE_ENV || 'development'
+const port = parseInt(process.env.PORT, 10) || 3000
+const server = Container.get(Server)
+
+// connect to database and start listening
+createConnection()
+    .then(() => server.prepare(env))
+    .then(() => server.listen(port))
+    .catch(error => console.error(error))

src/migrations/.gitkeep

@@ -0,0 +1,11 @@
+import { Service } from 'typedi'
+import { JsonController, Get } from 'routing-controllers'
+
+@Service()
+@JsonController('/status')
+export class UserController {
+    @Get('/')
+    public async createUser() {
+        return 'success'
+    }
+}

src/modules/.gitkeep

@@ -0,0 +1,15 @@
+import test from 'ava'
+import { factory } from '../../index.test'
+
+test('GET /', async t => {
+    t.plan(2)
+
+    const server = await factory()
+    const response = await server.get('/api/status')
+
+    t.is(response.status, 200)
+    t.deepEqual(response.body, {
+        data: 'success',
+        status: 200,
+    })
+})