Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 4.95 KB

README.md

File metadata and controls

84 lines (61 loc) · 4.95 KB
Raw

Node.js CI Maintainability Dependencies Vulnerabilities Node 11 Npm 6 Webpack 5 codecov Coverage Status contributions welcome PRs Welcome code style: Eslint FOSSA Status 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 for defining models.

  1. Create the following environment variables in your node project.
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"
  1. 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.

🪲 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 <script> 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.