WSO2 API Manager Portals

Branch / Status	Jenkins	Travis CI
master

WSO2 API Manager apps consists of several loosely coupled modules.

    * API Publisher portal
    * API Developer portal
    * API Admin portal
    * Portals integration tests

Setup build environment

Install NodeJS 14.x or later LTS version from https://nodejs.org/en/download/.

Note :-

You may use nvm tool to manage NodeJS on your development environment

Note :-

You can skip following steps if you don not want to build product-apim binaries

Install Maven from https://maven.apache.org/download.cgi. * For Maven 3.8 and up, please check the Troubleshoot section.
Install JDK 1.8 https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html.

Building & Running

Build

Download or clone the project source code from https://github.com/wso2/apim-apps
Open the portals/ directory (where the lerna.json is located)
Run following commands from the portals/ directory :

i. Run npm run bootstrap to install the dependencies for all 3 portals

ii. Run npm run build:prod to build all 3 portal apps
If you are building the product-apim,
Run mvn clean install from the command line in the project root directory (where the root pom.xml is located).
Then you just need to build WSO2 API Manager Server after. (Follow the guide there)

Run

Extract the wso2am-4.0.0.zip and go to the 'bin' directory
Run the api-manager.sh or api-manager.bat script based on you operating system.
Access the respective WSO2 API-M interfaces
- API Publisher web application is running at - https://localhost:9443/publisher
  You may sign in to the Publisher using the default administrator credentials (username: admin, password: admin).
- Developer Portal web application is running at - https://localhost:9443/devportal
  You may sign in to the Developer Portal using the default administrator credentials (username: admin, password: admin).

Run in dev mode

If you do not build a WSO2 API Manager server from the above steps, Download the built distribution of WSO2 API Manager Server from http://wso2.com/api-manager.
Execute api-manager.sh (For unix environment) or api-manager.bat (For windows environment) file from the bin directory to run WSO2 API Manager Server.
Goto portals/ directory in the apim-apps repository
Run npm start to start all three portals in development mode.

Note :-

If you haven't bootstrap the dependencies you have to run npm run bootstrap before starting the development build

Running Tests

Unit Tests

Product Unit tests have been implemented using Jest along with enzyme

Run Tests for individual module

Go to the respective individual portals directory

i:e /portals/publisher/
and run
```
npm run test
```
For more information regarding the test module, checkout the README in the publisher Tests module.

Integration Tests

Product integration tests have been written using Cypress Testing Framework and you can run the test suites using the following command.

Goto /tests/cypress/

Headless mode

Run
```
npm run test
```

Interactive mode (with GUI)

Run
```
npm run test:gui
```

Support

WSO2 Inc. offers a variety of development and production support programs, ranging from Web-based support up through normal business hours, to premium 24x7 phone support.

For additional support information please refer to http://wso2.com/support

For more information on WSO2 API Manager please visit https://wso2.com/api-management/

Known Issues of WSO2 API Manager

All known issues of WSO2 API Manager are filed at:

https://github.com/wso2/product-apim/issues

chashikajw/apim-apps