Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodearch/nodearch
Node.js Backend Framework.
https://github.com/nodearch/nodearch
backend bluemax-io expressjs framework javascript nodejs rush typescript web
Last synced: 3 days ago
JSON representation
Node.js Backend Framework.
- Host: GitHub
- URL: https://github.com/nodearch/nodearch
- Owner: nodearch
- License: mit
- Created: 2020-12-17T16:14:28.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T11:27:19.000Z (about 1 month ago)
- Last Synced: 2024-11-07T21:09:51.574Z (7 days ago)
- Topics: backend, bluemax-io, expressjs, framework, javascript, nodejs, rush, typescript, web
- Language: TypeScript
- Homepage: https://nodearch.io
- Size: 2.76 MB
- Stars: 39
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
NodeArch
## 👋 Welcome to NodeArch
NodeArch is a backend framework for Node.js that aims to address design and architectural issues when building Node.js applications. It uses Typescript and dependency injection to bring concepts from languages like Java and C# to Node.js, while still taking advantage of Javascript's flexibility and Node.js's non-blocking I/O model. NodeArch is designed to work seamlessly with existing tools and libraries, rather than replacing them, and focuses on creating a readable, maintainable, and scalable application architecture. It acts as a glue that connects all your tools and libraries together, making it easier to develop and maintain your Node.js applications.
## 🔗 Links
* [Homepage](https://nodearch.io)
* [Documentation](https://nodearch.io/docs)
## 📦 Install
To create new NodeArch apps, you need to install the NodeArch command-line interface (CLI) on your machine. To do this, open your terminal and run the following command:
```sh
npm i -g @nodearch/cli
```
Once you have installed the NodeArch command-line interface (CLI), you can use it to see the available options and usage instructions. To do this, open your terminal and run the following command:
```sh
nodearch -h
```
## 🚀 Usage
```sh
# 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
```
```bash
❯ nodearch -h
Usage: nodearch [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](https://nodearch.io/docs)
## 🤝 Contributing
If you would like to contribute to the NodeArch project, report an issue, or request a new feature, you can use the GitHub Issue tracker to communicate with the development team. Contributions, issues, and feature requests are all welcome, and we encourage you to share your thoughts and ideas with us through the Issue tracker. If you have an idea for improving NodeArch, adding new functionality, or suggesting something else, please don't hesitate to use the Issue tracker to let us know.
## 👷 Development
### Prerequisites
* [Node.js](https://nodejs.org/en/download/)
* [Microsoft Rush](https://rushjs.io/pages/intro/get_started/)
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
### Setup
To clone the NodeArch project onto your local machine, you can use the following command in your terminal:
```bash
git clone https://github.com/nodearch/nodearch.git
```
This will create a local copy of the NodeArch project on your machine, allowing you to access the source code and make changes as needed.
Switch to the repo directory, and then install dependencies
```bash
rush install
```
Now build the project
```bash
rush build
```
### Usage
```bash
# 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](https://rushjs.io/pages/intro/welcome/)
## Show your support
Give a ⭐️ if this project helped you!
[](https://github.com/bluemax-io/nodearch/stargazers)
## 📝 License
This project is [MIT](https://github.com/BlueMax-IO/nodearch/blob/master/LICENSE) licensed.
***
Open Source Software made with ❤️ for the Node.js Community. [Ahmed Ali](https://github.com/AhmedAli7O1)