first commit

Author: CodebitsDesign

.gitignore

@@ -0,0 +1,7 @@
+node_modules
+dist
+npm-debug.log
+
+#properties
+
+.idea

README.md

@@ -0,0 +1,68 @@
+   
+# typescript-mean-models
+
+The models of the Typescript MEAN(MongoDB-Express-Angular-Node) Stack Boilerplate.
+
+## Models
+
+Since both the backend and the frontend are using the same data-structure, the data-models are stored and maintained independently.
+
+In order to write new models, add a new `my-model.model.ts` file and export it in `index.d.ts`. Once you're done, you can `npm version patch` (or `yarn version`) and then `npm publish` (or `yarn publish`). Like this, the models are retrievable by `npm` (or, `yarn`) in the `backend-` and `frontend-`projects, in order for them to be truly separated into their own git repos.
+
+
+Step 1. Updates the package version.
+  <https://yarnpkg.com/en/docs/cli/version>
+```bash
+// question New Version:
+$ yarn version
+```
+> ```js
+> info Current version: 0.0.1
+> question New version: 0.1.0
+> info New version: 0.1.0
+> Done in 9.42s.
+> ```
+
+Step 2-A. Publishes a package to the `npm` registry.
+  <https://yarnpkg.com/en/docs/cli/publish>
+```bash
+$ yarn publish
+```
+> Publishes the package defined by the `package.json` in the current directory.
+
+
+Step 2-B. Publishes a package to the `github` repository.
+
+(1). [Create a new repository](https://help.github.com/articles/creating-a-new-repository/) on GitHub.
+
+ To avoid errors, do not initialize the new repository with `README`, `license`, or `gitignore` files. 
+```
+Repository name: typescript-mean-models
+```
+
+(2). Open Terminal and change the current working directory to your local project. 
+Then process git commands:
+
+> Show the working tree status:
+
+```bash
+$ git status
+```
+
+> If you haven’t initialised a Git repository in the project directory, 
+> use the below command to initialise the local directory as Git repository:
+
+```bash
+$ git init 
+```
+
+> Push the local repository to `Github` site:
+
+```bash
+$ git add .
+$ git commit -m "first commit"
+$ git remote add origin https://github.com/CodebitsDesign/typescript-mean-models.git
+$ git push -u origin master
+```
+> > and you can simply use the command `git push` next time.
+

package.json

@@ -0,0 +1,16 @@
+{
+  "name": "typescript-mean-models",
+  "version": "0.0.1",
+  "description": "The models of the Typescript MEAN Stack Boilerplate",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Seokjin Seo <[email protected]>",
+  "license": "MIT",
+  "dependencies": {
+    "bcrypt": "^1.0.2",
+    "inversify": "^3.3.0",
+    "reflect-metadata": "^0.1.10"
+  }
+}

src/api.ts

@@ -0,0 +1,25 @@
+import {User} from "./user.model";
+import {Item} from "./item.model";
+
+export interface api {
+  v1: {
+    user: StandardRestInterface<User, {}>,
+    item: StandardRestInterface<Item, {}>
+  }
+}
+
+interface StandardRestInterface<T, K> {
+  get: {
+    id: string;
+    queryParams?: K;
+  },
+  post: {
+    payload: T;
+  },
+  put: {
+    paylaod: T;
+  },
+  delete: {
+    id: string
+  }
+}

src/app-properties.model.ts

@@ -0,0 +1,13 @@
+export interface AppProperties {
+  db: {
+    host: string;
+    dbname: string;
+    port: number;
+    dbuser: string;
+    dbpassword: string;
+  },
+  redis: {
+    url: string;
+    secret: string;
+  }
+}

src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './app-properties.model';
+export * from './key.model';
+export * from './user.model';

src/item.model.ts

@@ -0,0 +1,4 @@
+export interface Item {
+  id: string;
+  title: string;
+}

src/key.model.ts

@@ -0,0 +1,13 @@
+export interface ResourceKey {
+  user: string;
+  id: string;
+  role: string;
+}
+
+export enum Roles {
+  ITEM_OWNER
+}
+
+export enum Activity {
+  READ_ITEM, UPDATE_ITEM
+}

src/user.model.ts

@@ -0,0 +1,10 @@
+export interface User {
+  id: string;
+  email: string;
+  password: {
+    hash: string;
+    algo: HashingAlgo;
+  }
+}
+
+type HashingAlgo = 'bcrypt'

tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["es6"],
+    "types": ["reflect-metadata"],
+    "module": "commonjs",
+    "outDir": "dist",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}