|
1 |
| -## [PureMVC](http://puremvc.github.com/) TypeScript MultiCore Framework |
2 |
| -PureMVC is a lightweight framework for creating applications based upon the classic [Model-View-Controller](http://en.wikipedia.org/wiki/Model-view-controller) design meta-pattern. This is a TypeScript port of the [AS3 reference implementation of the MultiCore Version](https://github.com/PureMVC/puremvc-as3-multicore-framework/wiki). It supports [modular programming](http://en.wikipedia.org/wiki/Modular_programming) through the use of [Multiton](http://en.wikipedia.org/wiki/Multiton) Core actors instead of the [Singleton](http://en.wikipedia.org/wiki/Singleton_pattern)s used in the [Standard Version](https://github.com/PureMVC/puremvc-typescript-standard-framework/wiki). |
| 1 | +## [PureMVC](http://puremvc.org/) TypeScript MultiCore Framework [](https://github.com/PureMVC/puremvc-typescript-multicore-framework/actions/workflows/node.js.yml) |
3 | 2 |
|
4 |
| -* [Discussion](http://forums.puremvc.org/index.php?board=113.0) |
5 |
| -* [Live Unit Test Runner](http://puremvc.org/pages/demos/TS/PureMVC_TS_MultiCore_UnitTests/) |
| 3 | +PureMVC is a lightweight framework for creating applications based upon the classic [Model-View-Controller](http://en.wikipedia.org/wiki/Model-view-controller) design meta-pattern. It supports [modular programming](http://en.wikipedia.org/wiki/Modular_programming) through the use of [Multiton](http://en.wikipedia.org/wiki/Multiton) Core actors instead of the [Singletons](http://en.wikipedia.org/wiki/Singleton_pattern). |
6 | 4 |
|
7 |
| -## Status |
8 |
| -Production - [Version 1.1](https://github.com/PureMVC/puremvc-typescript-multicore-framework/blob/master/VERSION) |
9 |
| - |
10 |
| -## Platforms / Technologies |
11 |
| -* [TypeScript](http://www.typescriptlang.org/) |
12 |
| -* [require.js](http://jqueryui.com/) |
13 |
| -* [YUI Test](https://github.com/yui/yuitest) |
14 |
| -* [YUI Compressor](http://developer.yahoo.com/yui/compressor/) |
15 |
| -* [YUIAnt](http://www.ubik-ingenierie.com/miscellanous/YUIAnt/) |
16 |
| -* [Ant](http://ant.apache.org/) |
17 |
| - |
18 |
| -## Usage |
| 5 | +* [NPM Package](https://www.npmjs.com/package/@puremvc/puremvc-typescript-multicore-framework?activeTab=readme) |
| 6 | +* [API Docs](https://puremvc.org/pages/docs/TypeScript/multicore/) |
| 7 | +* [Legacy Implementation](https://github.com/PureMVC/puremvc-typescript-multicore-framework/tree/1.3) |
19 | 8 |
|
20 |
| -As this port depends on the TypeScript language you may want to start by reading [TypeScript getting started guide](http://www.typescriptlang.org/). |
| 9 | +## Installation |
| 10 | +```shell |
| 11 | +npm i @puremvc/puremvc-typescript-multicore-framework |
| 12 | +``` |
21 | 13 |
|
22 |
| -Unit Test can be run live in the browser using included HTML file [test.html](https://github.com/PureMVC/puremvc-typescript-multicore-framework/blob/master/test-minified.html) |
| 14 | +## Demos |
| 15 | +* [React Native Demo: EmployeeAdmin](https://github.com/PureMVC/puremvc-typescript-demo-reactnative-employeeadmin) |
23 | 16 |
|
24 |
| -## Build |
25 |
| - |
26 |
| -To build the project you'll need to download and install : |
27 |
| -* [TypeScript compiler](http://www.typescriptlang.org/#Download) |
28 |
| -* [Ant](http://ant.apache.org/) |
29 |
| -* [JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html/) (Ant need a JDK not a JRE, also don't forget to change environment var JAVA_HOME to the JDK path). |
| 17 | +## Platforms / Technologies |
| 18 | +* [TypeScript](https://en.wikipedia.org/wiki/TypeScript) |
| 19 | +* [JavaScript](https://en.wikipedia.org/wiki/JavaScript) |
| 20 | +* [ECMAScript](https://en.wikipedia.org/wiki/ECMAScript) |
| 21 | +* [CommonJS](https://en.wikipedia.org/wiki/CommonJS) |
| 22 | +* [Node.js](https://en.wikipedia.org/wiki/Node.js) |
| 23 | +* [React](https://en.wikipedia.org/wiki/React_(JavaScript_library)) |
| 24 | +* [React Native](https://en.wikipedia.org/wiki/React_Native) |
30 | 25 |
|
31 |
| -1. Rename the file [user.properties.sample](https://github.com/PureMVC/puremvc-typescript-multicore-framework/blob/master/user.properties.sample) to **user.properties** |
32 |
| -2. Edit the file and replace **MY_TYPESCRIPT_COMPILER_PATH** by the real TypeScript compiler full |
33 |
| -system path. e.g. on windows: <code>typescript.compiler.path = C:/Documents and Settings/{USER NAME HERE}/Application Data/npm/tsc.cmd |
34 |
| -3. Use your favorite editor to run Ant or simply type <code>ant puremvc-typescript-multicore-framework/build |
| 26 | +## Status |
| 27 | +Production - [Version 2.0.0](https://github.com/PureMVC/puremvc-typescript-multicore-framework/blob/master/VERSION) |
35 | 28 |
|
36 | 29 | ## License
|
37 |
| -* PureMVC TypeScript Multicore Framework - Copyright © 2014 Frederic Saunier |
38 |
| -* PureMVC - Copyright © 2006-2014 Futurescale, Inc. |
| 30 | +* PureMVC MultiCore Framework for TypeScript - Copyright © 2024 [Saad Shams](https://www.linkedin.com/in/muizz) |
| 31 | +* PureMVC - Copyright © 2024 [Futurescale, Inc.](http://futurescale.com/) |
39 | 32 | * All rights reserved.
|
40 | 33 |
|
41 | 34 | * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
42 | 35 |
|
43 |
| - * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. |
44 |
| - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. |
45 |
| - * Neither the name of Futurescale, Inc., PureMVC.org, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. |
| 36 | + * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. |
| 37 | + * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. |
| 38 | + * Neither the name of Futurescale, Inc., PureMVC.org, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. |
46 | 39 |
|
47 | 40 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| 41 | + |
0 commit comments