# @actyx-contrib/axp
> Actyx Project CLI tool to create and maintain your TypeScript based projects
Latest version **1.5.0** (published 2021-07-19) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install @actyx-contrib/axp
pnpm add @actyx-contrib/axp
yarn add @actyx-contrib/axp
bun add @actyx-contrib/axp
```
Provides the command `axp`.
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.5.0 |
| Published | 2021-07-19 |
| First published | 2020-07-03 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 100.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Actyx AG |
| Maintainers | alex(actyx), ostollmann, roland.kuhn |
| Keywords | actyx, industry, industry 4.0, actyxOs, project, cli, pond, react |
## Links
- npm: https://www.npmjs.com/package/@actyx-contrib/axp
- Repository: https://github.com/actyx-contrib/actyx-project-cli
- Homepage: https://github.com/actyx-contrib/actyx-project-cli#readme
- Issues: https://github.com/actyx-contrib/actyx-project-cli/issues
- npm.io page: https://npm.io/package/@actyx-contrib/axp
## Dependencies (6)
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.4.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.2.0
- [commander](https://npm.io/package/commander.md) ^5.1.0
- [cli-table3](https://npm.io/package/cli-table3.md) 0.6.0
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 1.5.0 (latest) — 2021-07-19
- 1.0.0-rc2 (beta) — 2020-07-03
- 1.4.0 — 2021-07-05
- 1.3.1 — 2021-04-22
- 1.3.0 — 2021-04-21
- 1.2.7 — 2021-03-11
- 1.2.6 — 2021-03-11
- 1.2.5 — 2021-03-03
- 1.2.4 — 2020-11-27
- 1.2.3 — 2020-11-26
- 1.2.2 — 2020-11-26
- 1.2.1 — 2020-11-03
- 1.2.0 — 2020-10-28
- 1.1.5 — 2020-09-10
- 1.1.4 — 2020-09-10
- … 7 more at https://npm.io/package/@actyx-contrib/axp/versions
## README
# Actyx-Project-CLI
Create a new project within seconds and start something awesome! This tool gives you the opportunity to create a TypeScript Node.js or a React application with one command.
## 📦 Installation
Install the Actyx-Project-CLI globally to have access to wherever you are. [npm package](https://www.npmjs.com/package/@actyx-contrib/axp).
```shell
npm install -g @actyx-contrib/axp
```
## 🛠️ Init Project
The installed `axp` tool will create you a monorepo with git, ESLint, and TypeScript.
In this project, you can add your apps with the `axp add ` command.
```bash
axp init
```
The init step is optional. You can directly create an new app with `axp add [ui|node]`
## 📑 React application
Create a new React-App with the `axp add ui` command. It will user _parcel_ as build tool.
The actyx manifest for a WebView app is generated automatically.
```bash
axp add ui --appName "awesome Ui" --test
```
After executing this command you will find some new scripts in you package.json
- `ui::start` run the app in dev mode with automatic rebuild
- `ui::build` build the React application to deploy it
## 📑 Node application
Create a new Node.js with the `axp add node` command.
```bash
axp add node --appName "awesome App" --test --docker
```
After executing this command you will find some new scripts in you package.json
- `node::start` run the `index.ts` in your application
- `node::build` build the node js application to deploy it
- `node::clean` remove the build folder.
## 🛠️ Add features
In AXP some widely used standard tools have been integrated, which can be activated via `axp addFeature `.
### UI apps
The following features are available for your UI application.
- `test` / `jest`: Add jest as test suit to your application and generate an example test for you. ([jestjs.io](https://jestjs.io/docs/getting-started))
- `storybook`: Add storybook to your complete project and add an example to your selected app. ([storybook.js.org](https://storybook.js.org/docs/react/get-started/introduction))
- `cordova`: Add a cordova wrapper in the app to package your app as executable for Android / Windows / MAC. ([cordova.apache.org](https://cordova.apache.org/))
### Node apps
The following features are available for a node application.
- `test` / `jest`: Both commands add jest as test suit to your application and generate an example test for you ([jestjs.io](https://jestjs.io/docs/getting-started))
- `docker`: Create some docker definitions to deploy your application as container ([docker.com](https://docs.docker.com/engine/reference/builder/))
## 📖 Commands
This list is a overview of the existing commands. Use the integrated help to get detailed information about the commands
| command | shortcut | Function |
| -------------------------------------------- | ----------------- | ---------------------------------------------------------------------------------- |
| `axp init` | `axp --init -v 3` | Initialize a new project in the current directory |
| `axp add [-n Name] [--test] [--jest]` | `axp a` | Create a new application with the given type and name |
| `axp addFeature ` | `axp af` | Add a new feature to the appName (test / jest / storybook / cordova / docker) |
| `axp list` | `axp ls` | List all existing apps and check if some unreferenced apps are in the package.json |
| `axp clean` | `axp c` | Remove unreferenced commands in the package.json |
| `axp help` | `axp -h` | Show the general help output |
| `axp --help` | ` -h` | Show the help output for a given command |
| `axp --version` | `axp -V` | axp version |
## 🤓 Developer tools
The best way to work and test the project is to run the `npm run build:watch` and `npm link` it once. From this moment on, you can manipulate the code and try the `axp` cli command in any directory
| Script | Description |
| --------------------------- | ----------------------------------------------------------------- |
| `npm run clean` | Clean lib and coverage folders |
| `npm run build` | Build project |
| `npm run build:watch` | Build project watch mode |
| `npm run lint` | Check for lint issues |
| `npm run lint:fix` | Check and automatically fix lint issues |
| `npm run license:add` | Append license information to every relevant files |
| `npm run license:check` | Check if license information is present on every relevant files |
| `npm run license:check-dep` | Check the licenses for project dependencies and produce a summary |
---
_Source: https://npm.io/package/@actyx-contrib/axp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._