nope/README.md

52 lines
1.5 KiB
Markdown
Raw Normal View History

![](public/logo.png)
2020-08-25 22:11:26 +00:00
2021-01-21 15:38:45 +00:00
# No Programming Environment - `NoPE`
2021-01-21 15:42:21 +00:00
`NoPE` provides the basics for a distributed system. The `NoPE` basically links all modules to a system. It hides the distribution. The modules can run on multiple nodes (computation nodes) and `NoPE` takes care of coupling them, executing services and subscribing to events etc.
In Addtion, `NoPE` provides a basic concept for a front-end. This front-end will run on `next.js`.
Nope is availabel in multiple Programming-Languages:
- `nodejs`
- `python`
2021-01-21 15:38:45 +00:00
# Installation.
## Installing using Batch-File (Windows ONLY)
> This approach works on windows only.
To install `NoPE` just extecute the `00-install.bat`-Batch-File in the root-directory.
## Manual Installation
Make shure you run the following tasks
1. `npm install`
2022-11-06 10:47:36 +00:00
2. `./00-compile.bat` (on windows) or `./00-compile.sh` (on linux)
3. `./05-link.bat` (on windows) or `./05-link.sh` (on linux)
2021-01-21 15:38:45 +00:00
# Usage
## NoPE - Command Line Interface.
After installation you can use the following cli-tool:
2021-05-20 07:55:56 +00:00
> `nope-js`
2021-01-21 15:38:45 +00:00
Please select the option you want. Therefore add one of the following options:
2022-11-06 10:47:36 +00:00
- `help` Show this help.
- `run` Start a NoPE-Backend.
- `init` Initialize a new project. This project is empty.
- `conf` Trys to update the configuration file.
- `scan-ui` Scans and extracts the provided uis.
- `upload-ui` Uploads the determined ui-file
- `service` Generate Helper Files to provide services
- `repl` Opens an interactive console.
2021-08-17 15:52:46 +00:00
# Changelog
Checkout our [changelog](./CHANGELOG.md).