mirror of
https://github.com/ansible/awx.git
synced 2026-01-11 18:09:57 -03:30
Update readme with new build info
This commit is contained in:
parent
3ad62f586b
commit
41fa3e0473
@ -3,31 +3,72 @@
|
||||
## Requirements
|
||||
- node 10.x LTS, npm 6.x LTS, make, git
|
||||
|
||||
## Usage
|
||||
|
||||
* `git clone git@github.com:ansible/awx.git`
|
||||
* cd awx/ui_next
|
||||
* npm install
|
||||
* npm start
|
||||
* visit `https://127.0.0.1:3001/`
|
||||
|
||||
**note:** These instructions assume you have the [awx](https://github.com/ansible/awx/blob/devel/CONTRIBUTING.md#running-the-environment) development api server up and running at `localhost:8043`. You can use a different backend server with the `TARGET_HOST` and `TARGET_PORT` environment variables when starting the development server:
|
||||
## Development
|
||||
The API development server will need to be running. See [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
||||
|
||||
```shell
|
||||
# use a non-default host and port when starting the development server
|
||||
TARGET_HOST='ec2-awx.amazonaws.com' TARGET_PORT='443' npm run start
|
||||
# Start the ui development server. While running, the ui will be reachable
|
||||
# at https://127.0.01:3001 and updated automatically when code changes.
|
||||
npm --prefix=awx/ui_next start
|
||||
```
|
||||
|
||||
## Unit Tests
|
||||
### Using an External Server
|
||||
If you normally run awx on an external host/server (in this example, `awx.local`),
|
||||
you'll need to update your django settings and use the `TARGET_HOST` and `TARGET_PORT` environment variables:
|
||||
|
||||
To run the unit tests on files that you've changed:
|
||||
* `npm test`
|
||||
```shell
|
||||
echo "CSRF_TRUSTED_ORIGINS = ['awx.local:8043']" >> /awx/settings/development.py
|
||||
TARGET_HOST='awx.local:8043' TARGET_PORT=8043 npm --prefix awx/ui_next start
|
||||
```
|
||||
|
||||
To run a single test (in this case the login page test):
|
||||
* `npm test -- src/screens/Login/Login.test.jsx`
|
||||
## Testing
|
||||
```shell
|
||||
# run code formatting check
|
||||
npm --prefix awx/ui_next run prettier-check
|
||||
|
||||
**note:** Once the test watcher is up and running you can hit `a` to run all the tests
|
||||
# run lint checks
|
||||
npm --prefix awx/ui_next run lint
|
||||
|
||||
# run all unit tests
|
||||
npm --prefix awx/ui_next run test
|
||||
|
||||
# run a single test (in this case the login page test):
|
||||
npm --prefix awx/ui_next test -- src/screens/Login/Login.test.jsx
|
||||
|
||||
# start the test watcher and run tests on files that you've changed
|
||||
npm --prefix awx/ui_next run test-watch
|
||||
```
|
||||
#### Note:
|
||||
- Once the test watcher is up and running you can hit `a` to run all the tests.
|
||||
- All commands are run on your host machine and not in the api development containers.
|
||||
|
||||
|
||||
## Adding Dependencies
|
||||
```shell
|
||||
# add an exact development or build dependency
|
||||
npm --prefix awx/ui_next install --save-dev --save-exact dev-package@1.2.3
|
||||
|
||||
# add an exact production dependency
|
||||
npm --prefix awx/ui_next install --save --save-exact prod-package@1.23
|
||||
|
||||
# add the updated package.json and package-lock.json files to scm
|
||||
git add awx/ui_next_next/package.json awx/ui_next_next/package-lock.json
|
||||
```
|
||||
|
||||
## Removing Dependencies
|
||||
```shell
|
||||
# remove a development or build dependency
|
||||
npm --prefix awx/ui_next uninstall --save-dev dev-package
|
||||
|
||||
# remove a production dependency
|
||||
npm --prefix awx/ui_next uninstall --save prod-package
|
||||
```
|
||||
|
||||
## Building for Production
|
||||
```shell
|
||||
# built files are placed in awx/ui_next/build
|
||||
npm --prefix awx/ui_next run build
|
||||
```
|
||||
|
||||
## CI Container
|
||||
|
||||
@ -39,4 +80,4 @@ docker build -t awx-ui-next .
|
||||
docker run --name tools_ui_next_1 --network tools_default --link 'tools_awx_1:awx' -e TARGET_HOST=awx -p '3001:3001' --rm -v $(pwd)/src:/ui_next/src awx-ui-next
|
||||
```
|
||||
|
||||
**note:** This is for CI, test systems, zuul, etc. For local development, see [usage](https://github.com/ansible/awx/blob/devel/awx/ui_next/README.md#usage)
|
||||
**Note:** This is for CI, test systems, zuul, etc. For local development, see [usage](https://github.com/ansible/awx/blob/devel/awx/ui_next/README.md#usage)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user