Skip to content

Commit

Permalink
Merge pull request #62 from SachiniSiriwardene/nodeModule
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
DivyaPremanantha authored Dec 3, 2024
2 parents df35d46 + 7982d97 commit da775f0
Showing 1 changed file with 27 additions and 5 deletions.
32 changes: 27 additions & 5 deletions README.md
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'

0 comments on commit da775f0

Please sign in to comment.