initial commit

Author: Umed Khudoiberdiev

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+src/**/*.js
+src/**/*.js.map

README.md

@@ -0,0 +1,13 @@
+# Example how to use Express and TypeORM with TypeScript
+
+1. clone repository 
+2. run `npm i`
+3. edit `ormconfig.json` and change your database configuration (you can also change a database type, but don't forget to install specific database drivers)
+4. run `npm start`
+5. open `http://localhost:3000/posts` and you'll empty array
+6. use curl, postman or other tools to send http requests to test your typeorm-based API
+
+## How to use CLI?
+
+1. install `typeorm` globally: `npm i -g typeorm`
+2. run `typeorm -h` to show list of available commands

ormconfig.json

@@ -0,0 +1,28 @@
+[
+  {
+    "name": "default",
+    "driver": {
+      "type": "mysql",
+      "host": "localhost",
+      "port": 3306,
+      "username": "test",
+      "password": "test",
+      "database": "test"
+    },
+    "autoSchemaSync": true,
+    "entities": [
+      "src/entity/*.js"
+    ],
+    "subscribers": [
+      "src/subscriber/*.js,"
+    ],
+    "migrations": [
+      "src/migration/*.js"
+    ],
+    "cli": {
+      "entitiesDir": "src/entity",
+      "migrationsDir": "src/migration",
+      "subscribersDir": "src/subscriber"
+    }
+  }
+]

package.json

@@ -0,0 +1,45 @@
+{
+  "name": "typeorm-typescript-koa-example",
+  "version": "0.0.1",
+  "description": "Example how to use Koa and TypeORM with TypeScript.",
+  "license": "MIT",
+  "readmeFilename": "README.md",
+  "author": {
+    "name": "Umed Khudoiberdiev",
+    "email": "pleerock.me@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/typeorm/typescript-koa-example.git"
+  },
+  "bugs": {
+    "url": "https://github.com/typeorm/typescript-koa-example/issues"
+  },
+  "tags": [
+    "orm",
+    "typescript",
+    "typescript-orm",
+    "typeorm-sample",
+    "typeorm-example",
+    "typeorm-koa-example"
+  ],
+  "devDependencies": {
+    "typescript": "^2.1.5"
+  },
+  "dependencies": {
+    "@types/koa": "^2.0.39",
+    "@types/koa-bodyparser": "^3.0.23",
+    "@types/koa-router": "^7.0.21",
+    "@types/node": "^7.0.4",
+    "body-parser": "^1.17.1",
+    "koa": "^2.2.0",
+    "koa-bodyparser": "^3.2.0",
+    "koa-router": "^7.0.1",
+    "mysql": "^2.12.0",
+    "reflect-metadata": "^0.1.9",
+    "typeorm": "0.0.9"
+  },
+  "scripts": {
+    "start": "tsc && node src/index.js"
+  }
+}

src/controller/PostGetAllAction.ts

@@ -0,0 +1,18 @@
+import {Context} from "koa";
+import {getEntityManager} from "typeorm";
+import {Post} from "../entity/Post";
+
+/**
+ * Loads all posts from the database.
+ */
+export async function postGetAllAction(context: Context) {
+
+    // get a post repository to perform operations with post
+    const postRepository = getEntityManager().getRepository(Post);
+
+    // load a post by a given post id
+    const posts = await postRepository.find();
+
+    // return loaded posts
+    context.body = posts;
+}

src/controller/PostGetByIdAction.ts

@@ -0,0 +1,24 @@
+import {Context} from "koa";
+import {getEntityManager} from "typeorm";
+import {Post} from "../entity/Post";
+
+/**
+ * Loads post by a given id.
+ */
+export async function postGetByIdAction(context: Context) {
+
+    // get a post repository to perform operations with post
+    const postRepository = getEntityManager().getRepository(Post);
+
+    // load a post by a given post id
+    const post = await postRepository.findOneById((context as any).params.id);
+
+    // if post was not found return 404 to the client
+    if (!post) {
+        context.status = 404;
+        return;
+    }
+
+    // return loaded post
+    context.body = post;
+}

src/controller/PostSaveAction.ts

@@ -0,0 +1,21 @@
+import {Context} from "koa";
+import {getEntityManager} from "typeorm";
+import {Post} from "../entity/Post";
+
+/**
+ * Saves given post.
+ */
+export async function postSaveAction(context: Context) {
+
+    // get a post repository to perform operations with post
+    const postRepository = getEntityManager().getRepository(Post);
+
+    // create a real post object from post json object sent over http
+    const newPost = postRepository.create(context.request.body);
+
+    // save received post
+    await postRepository.persist(newPost);
+
+    // return saved post back
+    context.body = newPost;
+}

src/entity/Category.ts

@@ -0,0 +1,12 @@
+import {Table, PrimaryColumn, Column} from "typeorm";
+
+@Table()
+export class Category {
+
+    @PrimaryColumn("int", { generated: true })
+    id: number;
+
+    @Column()
+    name: string;
+
+}

src/entity/Post.ts

@@ -0,0 +1,22 @@
+import {Table, PrimaryColumn, Column, ManyToMany, JoinTable} from "typeorm";
+import {Category} from "./Category";
+
+@Table()
+export class Post {
+
+    @PrimaryColumn("int", { generated: true })
+    id: number;
+
+    @Column()
+    title: string;
+
+    @Column("text")
+    text: string;
+
+    @ManyToMany(type => Category, {
+        cascadeInsert: true
+    })
+    @JoinTable()
+    categories: Category[];
+
+}

src/index.ts

@@ -0,0 +1,28 @@
+import "reflect-metadata";
+import {createConnection} from "typeorm";
+import * as Koa from "koa";
+import * as Router from "koa-router";
+import * as bodyParser from "koa-bodyparser";
+import {AppRoutes} from "./routes";
+
+// create connection with database
+// note that its not active database connection
+// TypeORM creates you connection pull to uses connections from pull on your requests
+createConnection().then(async connection => {
+
+    // create koa app
+    const app = new Koa();
+    const router = new Router();
+
+    // register all application routes
+    AppRoutes.forEach(route => router[route.method](route.path, route.action));
+
+    // run app
+    app.use(bodyParser());
+    app.use(router.routes());
+    app.use(router.allowedMethods());
+    app.listen(3000);
+
+    console.log("Koa application is up and running on port 3000");
+
+}).catch(error => console.log("TypeORM connection error: ", error));