@nodearch/vault v2.0.4

👋 Welcome to NodeArch

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 opensource 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.

🔗 Links

• Homepage
• Documentation

📦 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 run nodearch -h in your terminal to see the usage.

🚀 Usage

# start your app
nodearch start

# start your app in Watch mode
nodearch  start -w

# run test cases
nodearch test

# run test cases in watch mode
nodearch test -w

# build your app ( only required in production mode )
nodearch build

❯ nodearch -h
Usage: nodearch <command> [options]

Commands:
  nodearch build  Build NodeArch app                                [aliases: b]
  nodearch new    Generate new NodeArch APP                         [aliases: n]
  nodearch start  Start NodeArch APP                                [aliases: s]
  nodearch test   run automated testing                             [aliases: t]

Options:
  -y, --notify   turn desktop notifier on or off       [boolean] [default: true]
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

Examples:
  nodearch new    generates new app
  nodearch build  build existing app from the current directory
  nodearch start  starts existing app from the current directory

for all the options, please check the documentation

🤝 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

• Node.js
• Microsoft Rush
• Git

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

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 BlueMax IO. This project is MIT licensed.

Open Source Software made with ❤️ for the Node.js Community. © BlueMax IO. All rights reserved. Ahmed Ali