Skip to main content

Introduction

NodeArch Logo

Welcome to NodeArch

Programming Language Version License: MIT Downloads Code Coverage Vulnerabilities Build Status Star on GitHub

NodeArch is a Node.js backend framework targeting to solve the design and architectural problems when creating Node.js APPs for the backend. Using Typescript and dependency injection, we bring the concepts we used to in languages like Java, C# etc. While still getting the best out of Javascript flexibility and Node.js non-blocking I/O model. There is also a big focus on wiring everything together, so our intention is not to reinvent/rewrite the tools/frameworks we already know and use. Instead, our target is to wire everything together and leverage the open-source community behind Node.js and Javascript. You can think of NodeArch as the glue that links all your tools and libraries together and helps create a readable, maintainable and scalable application architecture.

Getting started

๐Ÿ“ฆ Install

You need to install the NodeArch command-line interface to be able to generate new apps. Start by Running the following command in your terminal to install the CLI globally.

npm i -g @nodearch/cli

Once installed, you can generate a quick template to get started with the framework.

nodearch new

To view the full CLI usage, run the following:

nodearch -h

Contributing

Contributions, issues and feature requests are welcome! If you like the idea and want to improve, add, or suggest something, please use the GitHub Issue tracker to communicate your thoughts with us.

๐Ÿ‘ท Development

Prerequisites

Setup

Clone the project on your local machine, using the following command.

git clone https://github.com/BlueMax-IO/nodearch.git

Switch to the repo directory, and then install dependencies

rush install

Now build the project

rush build

Usage

# Build the project
rush build

# Run test cases
rush test

# Add NPM package as a dependency
rush add

For more details on how to use Rush to add packages, commands, build and run stuff. check it on the official Rush website

โญ๏ธ Support

Give a โญ๏ธ if this project helped you!

Star on GitHub

๐Ÿ“ License

Open Source Software made with โค๏ธ for the Node.js Community and developed under MIT license.