| 1 | # We.js core module :green_heart:
|
| 2 |
|
| 3 | [](https://gitter.im/wejs/we?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://travis-ci.org/wejs/we-core)
|
| 4 |
|
| 5 | **Main repository: https://github.com/wejs/we **
|
| 6 |
|
| 7 | Site: [http://wejs.org](https://wejs.org)
|
| 8 |
|
| 9 | Status: **maintained**
|
| 10 |
|
| 11 | [**Changelog**](CHANGELOG.md)
|
| 12 |
|
| 13 | ## Install for develop we.js core:
|
| 14 |
|
| 15 | After install npm and node.js
|
| 16 |
|
| 17 | ```js
|
| 18 | // clone this project
|
| 19 | git clone https://github.com/wejs/we-core.git
|
| 20 | // enter in cloned folder
|
| 21 | cd we-core
|
| 22 | // install all dependencies
|
| 23 | npm install
|
| 24 | // test
|
| 25 | npm test
|
| 26 | ```
|
| 27 |
|
| 28 | ## Development:
|
| 29 |
|
| 30 | Run `npm run cw` for compile files in src to lib folder
|
| 31 |
|
| 32 | Only edit code in **src** folder
|
| 33 |
|
| 34 | ### How to test
|
| 35 |
|
| 36 | after clone and install npm packages:
|
| 37 |
|
| 38 | ```sh
|
| 39 | npm test
|
| 40 | ```
|
| 41 |
|
| 42 | ##### For run only 'userFeature' test use:
|
| 43 |
|
| 44 | ```sh
|
| 45 | we test -g 'resourceRequests'
|
| 46 | ```
|
| 47 |
|
| 48 | ##### For run the code coverage
|
| 49 |
|
| 50 | ```sh
|
| 51 | npm run coverage
|
| 52 | ```
|
| 53 | ## V3 migration
|
| 54 |
|
| 55 | - Breaking changes in sequelize ORM: Updated to v5.x
|
| 56 | - Breaking changes in winston logger: Updated to v3.x
|
| 57 | - string npm module removed from we.utils.string and dependencies.
|
| 58 |
|
| 59 | ## V2 migration
|
| 60 |
|
| 61 | - Breaking changes in ORM: http://docs.sequelizejs.com/manual/tutorial/upgrade-to-v4.html
|
| 62 |
|
| 63 | ## License
|
| 64 |
|
| 65 | [the MIT license](LICENSE.md).
|
| 66 |
|
| 67 | ## Sponsored by
|
| 68 |
|
| 69 | - Linky: https://linkysystems.com
|
| 70 |
|