https://github.com/fractalerp/fractal-js
Component Based NodJs Framework. We are creating a structure for developing large scalable, maitanable Nodejs applications. We mash up ideas from component based architecture, MVC, Entity Framework and Repository Pattern.
https://github.com/fractalerp/fractal-js
component component-architecture entity-framework express-js mvc-architecture node-js nodejs repository-pattern
Last synced: 3 months ago
JSON representation
Component Based NodJs Framework. We are creating a structure for developing large scalable, maitanable Nodejs applications. We mash up ideas from component based architecture, MVC, Entity Framework and Repository Pattern.
- Host: GitHub
- URL: https://github.com/fractalerp/fractal-js
- Owner: fractalerp
- License: mit
- Created: 2024-08-09T09:14:21.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T03:52:54.000Z (4 months ago)
- Last Synced: 2025-01-31T01:07:38.682Z (4 months ago)
- Topics: component, component-architecture, entity-framework, express-js, mvc-architecture, node-js, nodejs, repository-pattern
- Language: TypeScript
- Homepage:
- Size: 4.12 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/fractalerp/fractal-js/actions/workflows/ci.yml)
[](https://codeclimate.com/github/fractalerp/fractal-js/maintainability)
[](https://libraries.io/npm/@fractalerp%2Ffractal-js)
[](https://snyk.io/test/github/fractalerp/fractal-js)
[](https://codecov.io/gh/fractalerp/fractal-js)
[](https://coveralls.io/github/fractalerp/fractal-js?branch=main)
[](https://github.com/fractalerp/fractal-js/issues)
[](http://makeapullrequest.com)
[](https://eslint.org)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Ffractalerp%2Ffractal-js?ref=badge_shield)
[](http://opensource.org/licenses/mit)
# FRACTAL JS
A component based framework for NodeJs Applications
## 🧩 Architecture
We are creating a structure for developing large scalable, maitanable Nodejs applications. We mash up ideas from component based architecture, MVC, Entity Framework and Repository Pattern. We want different teams to focus on creating their domain apps in the components with ease.
## ⚙️ How to run the project
Prerequisite: Install git, node package manager, webpack CLI, grunt CLI. This framework also uses fractalerp [Active Record Js](https://github.com/fractalerp/active-record-js) for defining models.
1. Create the following environment variables in your node project.
```env
RDBMS_DATABASE_URI="mysql://DATBASE_USER:DATABASE_PASSWORD@DATABASE_HOST:DATABASE_PORT/DATABASE_DB"
NOSQL_DATABASE_URI="mongodb://DATABASE_HOST:DATABASE_PORT/DATABASE_DB"
NOSQL_DATABASE_ADAPTER="mongodb"
```
2. Then you can create your `nodejs` apps in the `components` folder. The projects in that folder are autoloaded at run time. See the sample `Task` project in the same folder. A proper documentation will be provided in the future. Also tools will be provided to create this structure. Refer to the github project management dashboard to see what is coming up.
## 🫶 Projects using this framework
See the projects using this framework in action.
- [Fractalerp core](https://github.com/fractalerp/fractal-core)
## 🪲 Issues, suggestions and feature requests
We are actively maintaining this boilerplate, please report any issues or suggestion for improvement at https://github.com/fractalerp/fractal-js/issues
## 👨💻 Development
To contribute, fork and clone.
> git clone https://github.com/fractalerp/fractal-js.git
The code is in typescript. Use a typescript IDE of your choice, like Visual Studio Code or WebStorm.
To set up the development environment, run:
> npm install
To automatically compile, bundle and push code changes to the running test project, run:
> npm start
To run the project unit tests with code coverage, results can be found at `dist/testresults/coverage/index.html`, run:
> npm run test:unit
Run the unit test continuously during development:
> npm run test:dev
## Scripts
While developing, you will probably rely mostly on `npm start`; however, there are additional scripts at your disposal:
|`npm run `|Description|
|------------------|-----------|
|`start`|Build the project and monitor source and config for changes and rebuild. Start the dev server|
|`watch`|Build the project and monitor source and config for changes and rebuild.|
|`prod:server:start`|starts the application in production as daemon and restart it in case of crashes|
|`prod:server:stop`|stop an instance of the application running|
|`emit`|Output javascript code|
|`test`|Runs lint, build, unit tests with mocha and generates a coverage report|
|`test:dev`|Runs mocha and watches for changes to re-run tests; does not generate coverage reports.|
|`test:unit`|Runs unit tests with mocha and generates a coverage report.|
|`build:release`|Build app optimized for production|
|`build:development`|Build app optimized for debugging.|
|`lint`|Lint all `.js` files.|
|`lint:fix`|Lint and fix all `.ts` files.|