Skip to content

Commit 8458415

Browse files
committed
docs: Add 'Local Development Environment' instructions
1 parent da120c7 commit 8458415

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

docs/Guidelines.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,37 @@
11
# Development Conventions and Guidelines
2+
## Local Development Environment
3+
You can use any IDE or text editor of your choice. There are no specific requirements or additions for a certain IDE.
4+
5+
### Prerequisites
6+
7+
- [Node.js](https://nodejs.org/) (See `engines` section in [package.json](../package.json) for the required version)
8+
- [npm](https://www.npmjs.com/) (comes with Node.js)
9+
10+
UI5 CLI is tested on Windows, macOS, and Linux. However, some tools and scripts require a Unix-like shell environment, so we recommend using [Git Bash](https://git-scm.com/install/windows) on Windows.
11+
12+
### Installation
13+
14+
1. Clone the repository and navigate into it:
15+
```sh
16+
git clone https://github.com/UI5/cli.git
17+
cd cli
18+
```
19+
2. Install all dependencies in the repository (npm workspace):
20+
```sh
21+
npm install
22+
```
23+
3. *(Optional)* If you want to test the CLI locally, you can link the package to make the `ui5` command available globally:
24+
```sh
25+
npm link --workspace @ui5/cli
26+
```
27+
**Note:** You might need to set the environment variable `UI5_CLI_NO_LOCAL` to `X` (or any value) to avoid invoking a local installation of UI5 CLI in your current working directory.
28+
29+
You can remove the global link using:
30+
```sh
31+
npm uninstall --global @ui5/cli
32+
```
33+
If you had previously installed UI5 CLI globally using `npm install --global @ui5/cli`, you need to re-install it after removing the link.
34+
235
## JavaScript Coding Guidelines
336
We enforce code style rules using [ESLint](https://eslint.org). Execute `npm run lint` to check your code for style issues.
437
You may also find an ESLint integration for your favorite IDE [here](https://eslint.org/docs/user-guide/integrations).

0 commit comments

Comments
 (0)