-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #62 from SachiniSiriwardene/nodeModule
Update README
- Loading branch information
Showing
1 changed file
with
27 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,31 @@ | ||
# DevPortal WebApp | ||
Pre-requisites | ||
-------------- | ||
Follow the steps given in InstallationGuide.md, to create database. | ||
|
||
## Overview | ||
1. Download the developer portal. | ||
|
||
2. Extract the downloaded zip. | ||
|
||
The DevPortal WebApp serves as a development portal offering fundamental layout and structural components. This repository contains the base code that can be installed as a node dependency. | ||
3. Execute the data-dump.sql script in the artifacts folder to populate the database with mock data. | ||
```bash | ||
psql -q -U "{db_username}" -d “test”_dump -h "{hostname}" -p "{port}" -f {path to data-dump.sql} | ||
``` | ||
|
||
4. Execute the startup script on the root, based on the OS: | ||
|
||
```bash | ||
For Linux or MacOS | ||
sh startup.sh | ||
For Windows | ||
startup.bat | ||
``` | ||
The default organization name is ACME. | ||
This will start the webapp in the following URL : ‘[http://localhost:3000/ACME](http://localhost:3000/{orgName})’ | ||
|
||
## Getting Started | ||
This will direct you to the organization landing page. | ||
|
||
Follow the stesps in [DevPortal Developer WebApp](https://github.com/wso2/api-developer-portal) to set up and run the DevPortal locally. | ||
The ‘[http://localhost:3000/ACME](http://localhost:3000/{orgName})/apis’ will direct you to the api listing page. | ||
|
||
Each of the api landing and tryout pages are available at the following URLs: | ||
'http://localhost:3000/ACME/api/{apiName}' | ||
'http://localhost:3000/ACME/api/{apiName}/tryout' |