Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ara-framework/ara-cli
Command Line Interface for Ara Framework
https://github.com/ara-framework/ara-cli
command-line-interface
Last synced: 4 days ago
JSON representation
Command Line Interface for Ara Framework
- Host: GitHub
- URL: https://github.com/ara-framework/ara-cli
- Owner: ara-framework
- License: mit
- Created: 2019-06-04T17:21:54.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-02-27T11:10:54.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T09:04:48.496Z (3 months ago)
- Topics: command-line-interface
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ara-cli
- Size: 46.9 KB
- Stars: 53
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ara Framework CLI
> Scaffolding tool for Ara Framework
## Installation
You can install the package from npm.
```bash
npm i -g ara-cli
```
## Usage
### Create Ara Project
```bash
ara new:project ara-demo
```
### Create Nova Microfrontend
```bash
ara new:nova
```
By default the scaffolding for nova uses a Vue.js template but you can use more passing the flag `-t, --template`
Supported templates:
- vue
- angular
- svelte
- preact
- hyperapp
```bash
ara new:nova -t angular
```
### Run Hypernova (Nova) Lambda locally
Run command:
```shell
ara run:lambda
```
Serve the client script locally using an S3 local server:
```shell
ara run:lambda --asset
```
### Run Nova Proxy
Nova Proxy needs a configuration file:
```json
{
"locations": [
{
"path": "/",
"host": "http://localhost:8000",
"modifyResponse": true
}
]
}
```
Before to run the command we need to set the `HYPERNOVA_BATCH` variable using the Nova service endpoint.
```shell
export HYPERNOVA_BATCH=http://localhost:3000/batch
```
The command uses a configuration file named `nova-proxy.json` in the folder where the command is running, otherwise you need to pass the `--config` parameter with a different path.
```
ara run:proxy --config ./nova-proxy.json
```
### Run Nova Cluster
Nova Cluster needs a configuration file in order to map the views with their nova servers.
```json
{
"Navbar": {
"server": "http://localhost:3031/batch"
},
"Home": {
"server": "http://localhost:3030/batch"
}
}
```
The command uses a configuration file named `views.json` in the folder where the command is running, otherwise you need to pass the `--config` parameter with a different path.
```
ara run:cluster --config ./views.json
```