UNPKG

1.87 kBMarkdownView Raw
1# aurelia-path
2
3[![npm Version](https://img.shields.io/npm/v/aurelia-path.svg)](https://www.npmjs.com/package/aurelia-path)
4[![Discord Chat](https://img.shields.io/discord/448698263508615178.svg)](https://discord.gg/RBtyM6u)
5[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/aurelia/path)
6
7This library is part of the [Aurelia](http://www.aurelia.io/) platform and contains utilities for path manipulation.
8
9> To keep up to date on [Aurelia](http://www.aurelia.io/), please visit and subscribe to [the official blog](http://blog.aurelia.io/) and [our email list](http://eepurl.com/ces50j). We also invite you to [follow us on twitter](https://twitter.com/aureliaeffect). If you have questions, please [join our community on Discord](https://discord.gg/RBtyM6u) or use [stack overflow](http://stackoverflow.com/search?q=aurelia). Documentation can be found [in our developer hub](http://aurelia.io/hub.html).
10
11## Platform Support
12
13This library can be used in the **browser** as well as on the **server**.
14
15## Building The Code
16
17To build the code, follow these steps.
18
191. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
202. From the project folder, execute the following command:
21
22 ```shell
23 npm ci
24 ```
253. To build the code, you can now run:
26
27 ```shell
28 npm run build
29 ```
305. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.
31
32## Running The Tests
33
34To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
35
361. You can now run the tests with this command:
37
38 ```shell
39 npm test
40 ```
41
\No newline at end of file