Skip to content

Commit d81035a

Browse files
committed
Added READMEs
1 parent 289aae4 commit d81035a

File tree

6 files changed

+77
-11
lines changed

6 files changed

+77
-11
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
1-
# Incept.JS
1+
# Incept Mono Repo
22

3-
A pluggable React framework with the following concepts.
3+
> Still developing and testing. Not ready for production use.
44
5-
- Everything is a plugin
6-
- Everything is event driven
5+
## Read More
76

8-
## TODO
7+
- [types](https://github.com/inceptjs/incept.js/tree/main/packages/types)
8+
- [framework](https://github.com/inceptjs/incept.js/tree/main/packages/framework)
9+
- [incept](https://github.com/inceptjs/incept.js/tree/main/packages/incept)
910

10-
- Build Script
11-
- Run on Production
12-
- Event RPC
13-
- Admin Dashboard
11+
## Installing
12+
13+
Clone this repo and run the following commands in the project folder.
14+
15+
```js
16+
$ npm run bootstrap
17+
$ npm run build
18+
```
19+
20+
## Contributing
21+
22+
Always looking for contributors and sponsors. If your interested,
23+
[contact me](https://github.com/cblanquera) so we can discuss.

examples/pluggable-example/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010
"./plugin/static"
1111
],
1212
"dependencies": {
13-
"inceptjs": "^0.0.2"
13+
"inceptjs": "^0.0.11"
1414
}
1515
}

examples/vanilla-example/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
},
88
"incept": "./index",
99
"dependencies": {
10-
"inceptjs": "^0.0.2"
10+
"inceptjs": "^0.0.11"
1111
}
1212
}

packages/framework/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Incept Framework
2+
3+
This package defines basic framework concepts inspired by Express and
4+
is designed to be the basis in which frameworks can be built on top of.
5+
6+
## Install
7+
8+
```bash
9+
$ npm i --save @inceptjs/framework
10+
```

packages/incept/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Incept JS
2+
3+
An Unopinionated Typed React Web Framework
4+
5+
> Still developing and testing. Not ready for production use.
6+
7+
## Why ?
8+
9+
- Unopinionated. Design your own project structure.
10+
- Reusability. Develop plugins and deploy to npm.
11+
- Easy to Expert. Zero config to full customization.
12+
- No Tooling. React CSR & SSR out of the box.
13+
- Typescript First. Just import.
14+
15+
## Install
16+
17+
```bash
18+
npm i --save inceptjs
19+
```
20+
21+
See [Examples For now](https://github.com/inceptjs/incept.js/tree/main/examples)
22+
23+
## Under the Hood
24+
25+
- React 17
26+
- Webpack 5
27+
- Babel 7
28+
- Loadable Components
29+
- React Router

packages/types/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Incept Types
2+
3+
This package contains type definitions and generic implementations
4+
that work in Node or in the browser for the following packages.
5+
6+
- [EventEmitter](https://github.com/inceptjs/incept.js/tree/main/docs/events.md)
7+
- [Exception](https://github.com/inceptjs/incept.js/tree/main/docs/exception.md)
8+
- Reflection
9+
- Statuses
10+
- [Store](https://github.com/inceptjs/incept.js/tree/main/docs/store.md)
11+
- [TaskQueue](https://github.com/inceptjs/incept.js/tree/main/docs/taskqueue.md)
12+
13+
## Install
14+
15+
```bash
16+
$ npm i --save @inceptjs/types
17+
```

0 commit comments

Comments
 (0)