Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Atul committed Jun 28, 2018
1 parent f60d1ae commit 22651f1
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This module can be used for reference
## dependency
* oe-cloud
* oe-logger

## Installation, test cases and code coverage

### Installation
Expand Down Expand Up @@ -76,25 +76,24 @@ you should change this file as per your module.
$ eslint . --fix
```

### Developing oe-cloud module
## Developing oe-cloud module

You can do following things in this oe-cloud module.

* Add models specific to your module (see common/modles folder)
* Add mixins which will get attached to BaseEntity (see common/mixins folder)
* Add middleware (see server/middleware folder and server/middleware.json)
* Add Boot script (see server/boot folder)
*

### Developing test script
## Developing test script

There is test folder created. you need to modify following files for your project

## datasources*.json
### datasources*.json

There are several total 3 datasource.x.json files each for Mongo, PostgreSQL and Oracle. you should change database name at least for Mongo and PostgreSQL

## server.js
### server.js

you may want to run this module as independent server during your development. Mostly you don't have to chagne this file unless you are having mixin. For that have line similar to below for your mixin.

Expand All @@ -103,18 +102,16 @@ oecloud.attachMixinsToBaseEntity("SkeletonMixin");

```


## test.js
### test.js

This is typical mocha unit test case file. you can keep adding test cases to it.

### Adding models to your test scripts

you can add models that you want to use only for your test scripts in test/common/models folder and then modify test/model-config.json file to have entry for the model.

### Adding boot script to your test scripts

you can add boot script in test/boot folder. This will be executed as part of boot in application.







Similarly you can also have middleware/mixins for testing - which is mostly not required.

0 comments on commit 22651f1

Please sign in to comment.