feat(ormconfig): generate ormconfig (#47)

goldcaddy77 · Jan 26, 2019 · a470b2d · a470b2d
1 parent 89eb4b8
commit a470b2d
Show file tree

Hide file tree

Showing 33 changed files with 6,682 additions and 215 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,9 @@ yarn add warthog
 
 ## Usage
 
-Check out the [warthog-starter](https://github.com/goldcaddy77/warthog-starter) repo to see how to use Warthog in a project. There are also a bunch of examples in the [examples](./examples/README.md) folder.  Note that these use relative import paths to call into Warthog instead of pulling from NPM.
+Check out the [warthog-starter](https://github.com/goldcaddy77/warthog-starter) repo to see how to use Warthog in a project. There are also a bunch of examples in the [examples](./examples/README.md) folder.  
+
+Note that the examples in the [examples](./examples/README.md) folder use relative import paths to call into Warthog.  In your projects, you won't need to set this config value.  See [warthog-starter](https://github.com/goldcaddy77/warthog-starter/blob/master/src/app.ts) for how you should set this up.
 
 ### 1. Create a Model
 
@@ -73,16 +75,27 @@ export class UserResolver extends BaseResolver<User> {
 }
 ```
 
-### 3. Run your server
+### 3. Add config to .env file
+
+
+
+```env
+APP_HOST=localhost
+APP_PORT=4100
+TYPEORM_DATABASE=example2
+TYPEORM_USERNAME=postgres
+TYPEORM_PASSWORD=
+```
+
+### 4. Run your server
 
 ```typescript
 
 import 'reflect-metadata';
-import { Container } from 'typedi';
 import { Server } from 'warthog';
 
 async function bootstrap() {
-  const server = new Server({ container: Container });
+  const server = new Server();
   return server.start();
 }
 
@@ -161,11 +174,15 @@ Notice how we've only added a single field on the model and you get pagination,
 
 ## Config
 
-| value | ENV var | option name | default |
+All config is driven by environment variables.  Most options can also be set by setting the value when creating your `Server` instance.
+
+| variable | value | config option name | default |
 | --- | --- | --- | --- |
-| host | APP_HOST | appOptions.host | no default |
-| app port | APP_PORT | appOptions.port | 4000 |
-| generated folder | _none_ | appOptions.generatedFolder | _current-dir_ + `generated` |
+| APP_HOST | App server host | appOptions.host | _none_ |
+| APP_PORT | App server port | appOptions.port | 4000 |
+| TYPEORM_DATABASE | DB name | _none_ | _none_ |
+| TYPEORM_USERNAME | DB username | _none_ | _none_ |
+| TYPEORM_PASSWORD | DB password | _none_ | _none_ |
 
 ## Intentionally Opinionated
 

diff --git a/examples/1-simple-model/src/index.ts b/examples/1-simple-model/src/index.ts
@@ -1,11 +1,9 @@
 import 'reflect-metadata';
-import { Container } from 'typedi';
 
 import { Server } from '../../../src/';
 
 async function bootstrap() {
   const server = new Server({
-    container: Container,
     warthogImportPath: '../../../src' // Path written in generated classes
   });
 

diff --git a/examples/2-complex-example/package.json b/examples/2-complex-example/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "example1",
+  "name": "example2",
   "version": "0.0.0",
   "scripts": {
     "//": "make sure to install top-level packages, too",
@@ -13,7 +13,6 @@
     "start": "yarn start:ts",
     "start:debug": "yarn start:ts --inspect",
     "start:ts": "ts-node --type-check src/index.ts",
-    "typeorm:cli": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js -f ./ormconfig",
     "test": "dotenv -- jest --detectOpenHandles --verbose --coverage",
     "test:watch": "dotenv -- jest --watch",
     "watch:ts": "nodemon -e ts,graphql -x ts-node --type-check src/index.ts"

diff --git a/examples/2-complex-example/src/server.ts b/examples/2-complex-example/src/server.ts
@@ -1,11 +1,7 @@
 import 'reflect-metadata';
 
-import { Container } from 'typedi';
-
 import { BaseContext, Server } from '../../../src/';
 
-// import { User } from './modules/user/user.model';
-
 interface Context extends BaseContext {
   user: {
     email: string;
@@ -17,7 +13,6 @@ interface Context extends BaseContext {
 export function getServer(AppOptions = {}, dbOptions = {}) {
   return new Server<Context>(
     {
-      container: Container,
       // Inject a fake user.  In a real app you'd parse a JWT to add the user
       context: request => {
         return {

diff --git a/examples/3-one-to-many-relationship/package.json b/examples/3-one-to-many-relationship/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "example1",
+  "name": "example3",
   "version": "0.0.0",
   "scripts": {
     "//": "make sure to install top-level packages, too",

diff --git a/examples/3-one-to-many-relationship/src/index.ts b/examples/3-one-to-many-relationship/src/index.ts
@@ -1,11 +1,9 @@
 import 'reflect-metadata';
-import { Container } from 'typedi';
 
 import { Server } from '../../../src/';
 
 async function bootstrap() {
   const server = new Server({
-    container: Container,
     warthogImportPath: '../../../src' // Path written in generated classes
   });
 

diff --git a/examples/4-many-to-many-relationship/package.json b/examples/4-many-to-many-relationship/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "example1",
+  "name": "example4",
   "version": "0.0.0",
   "scripts": {
     "//": "make sure to install top-level packages, too",

diff --git a/examples/4-many-to-many-relationship/src/index.ts b/examples/4-many-to-many-relationship/src/index.ts
@@ -1,11 +1,9 @@
 import 'reflect-metadata';
-import { Container } from 'typedi';
 
 import { Server } from '../../../src/';
 
 async function bootstrap() {
   const server = new Server({
-    container: Container,
     warthogImportPath: '../../../src' // Path written in generated classes
   });
 

diff --git a/examples/5-migrations/.env b/examples/5-migrations/.env
@@ -0,0 +1,5 @@
+APP_HOST=localhost
+APP_PORT=4100
+TYPEORM_DATABASE=example5
+TYPEORM_USERNAME=postgres
+TYPEORM_PASSWORD=
diff --git a/examples/5-migrations/.gitignore b/examples/5-migrations/.gitignore
@@ -0,0 +1 @@
+generated/*
diff --git a/examples/5-migrations/README.md b/examples/5-migrations/README.md
@@ -0,0 +1,21 @@
+# Example 1 - User Model
+
+## Setup
+
+Run `yarn bootstrap && yarn start`
+
+## Bootstrapping the App
+
+Running `yarn bootstrap` will do the following:
+
+- Install packages
+- Create the example DB
+- Generate code in `generated` folder
+
+## Generate DB schema migration
+
+To automatically generate a schema migration file, run `yarn db:migration:generate`.  The migration will be put in the `db/migrations` folder
+
+## Run the DB migration
+
+To run the DB migration, run `yarn db:migration:run`
diff --git a/examples/5-migrations/examples.gql b/examples/5-migrations/examples.gql
@@ -0,0 +1,16 @@
+query {
+  users(orderBy: createdAt_DESC) {
+    id
+    lastName
+    createdAt
+  }
+}
+
+mutation {
+  createUser(data: { firstName: "Test", email: "test@fakeemail.com" }) {
+    id
+    firstName
+    lastName
+    createdAt
+  }
+}
diff --git a/examples/5-migrations/generated/classes.ts b/examples/5-migrations/generated/classes.ts
diff --git a/examples/5-migrations/generated/index.ts b/examples/5-migrations/generated/index.ts
diff --git a/examples/5-migrations/generated/ormconfig.ts b/examples/5-migrations/generated/ormconfig.ts
diff --git a/examples/5-migrations/nodemon.json b/examples/5-migrations/nodemon.json
@@ -0,0 +1,4 @@
+{
+  "verbose": true,
+  "ignore": ["dist/*", "generated/*"]
+}