Skip to content

Commit e979a9d

Browse files
committed
ReadMe modified
1 parent 07ec1a7 commit e979a9d

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

reactjs/README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,38 @@
22

33
The React.js integration for ABP Boilerplate framework. This template is built on React+Mobx+Typescript. SOLID, SoC principles are used.
44

5+
![](_screenshots/dashboard.jpg)
6+
7+
## Getting Started
8+
9+
### Installing
10+
11+
After cloning repository, first install npm packages:
12+
13+
```sh
14+
cd reactjs
15+
npm install
16+
```
17+
18+
And then start
19+
20+
```
21+
npm start
22+
```
23+
24+
## Deployment
25+
26+
```sh
27+
npm build
28+
```
29+
30+
## Built With
31+
32+
* [React](https://reactjs.org/) - The JavaScript library for building user interfaces
33+
* [Typescript](https://www.typescriptlang.org/) - Used for static typing
34+
* [Mobx](https://mobx.js.org/) - Simple, scalable state management
35+
* [AntDesign](https://ant.design/) - A design system with values of Nature and Determinacy for better user experience of enterprise applications
36+
537
# Architecture
638

739
This framework is designed by utilizing MVC design pattern and layered architecture as follows:
@@ -12,6 +44,15 @@ This framework is designed by utilizing MVC design pattern and layered architect
1244
- Presentational Component can use store directly by injecting the store or Props from Container Component can be passed in it.
1345
- Container or Presentational Component can invoke store actions and automatic rendering of component will be done by Mobx.
1446

15-
InversifyJS IoC container is used to ensure dependency inversion. All of services has one interface and one implementation, so mocks can be used easily when writing tests.
16-
1747
![](_screenshots/architecture.jpg)
48+
49+
## Authors
50+
51+
* **Rashiduddin Yoldash** - *Initial work* - [ryoldash](https://github.com/ryoldash)
52+
* **Mehmet Yasir Aktunç** - *Initial work* - [mhmtyasr](https://github.com/mhmtyasr)
53+
* **Samet Kabay** - *Initial work* - [smtkby](https://github.com/smtkby)
54+
55+
See also the list of [contributors](https://github.com/aspnetboilerplate/module-zero-core-template/graphs/contributors) who participated in this project.
56+
57+
58+

0 commit comments

Comments
 (0)