You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-8
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,37 @@ aws-serverless-developer-portal is a reference implementation for a developer po
5
5
It also optionally supports subscription/unsubscription through a SaaS product offering through the AWS Marketplace.
6
6
7
7
## Setup
8
-
First, ensure you have the latest AWS CLI installed http://docs.aws.amazon.com/cli/latest/userguide/installing.html.
8
+
9
+
### Prerequisites
10
+
First, ensure you have the [latest AWS CLI installed](http://docs.aws.amazon.com/cli/latest/userguide/installing.html) (version >= 1.11.19) as well as [Node.js](https://nodejs.org/en/download/) 4+. Then, clone this repo into a local directory
11
+
12
+
### List your products (APIs/Usage Plans)
13
+
Add your API Gateway APIs to the array in the `lambdas/backend/catalog.json` file, using the following format. If you have not yet created an API and Usage Plan, see [blog post]() for a detailed walkthrough. Alternatively, skip this step for now if you just want to get started with your developer portal (A placeholder API with swagger definition is provided for you for demonstration purposes, however, some features such as __Subscribe__ will not work)
__TIP:__ If you put your api product images in the `dev-portal/public` directory, you can simply do `"image": "/your-api-product-image.svg"`. `image` is also optional.
28
+
29
+
Add your swagger definition to the `swagger` property to enable documentation for your API.
30
+
31
+
### Setup and deploy
32
+
Run:
9
33
10
34
```js
11
-
npm install
12
-
npm run pre-config
13
35
npm run setup
14
-
npm run post-setup
15
36
```
16
37
17
-
Enter your new API Id, Dev Portal Function Name, Cognito User Pool ID, Cognito Client ID, and Cognito Identity Pool ID, available in Cloudformation __Outputs__. Click the WebsiteURL in the __Outputs__ section of your CloudFormation stack.
18
-
19
-
Update dev-portal/src/catalog.json with your API Gateway APIs and Usage Plans (if you do not yet have one, you will need to create it), and run `npm run upload-site`.
38
+
Follow the prompts and enter your account id, region, and names for your S3 buckets, CloudFormation stack, and API. The names you provide for the S3 buckets must be unique to that region (ie. not just unique to your account) so it is recommended to add a prefix or suffix (eg. my-org-dev-portal). You can choose to provide an existing bucket for the __artifacts__ S3 bucket name, or a new one (in which case it will be created for you). The __site__ S3 bucket must __NOT__ exist, as this is managed by the CloudFormation stack.
20
39
21
40
## Components
22
41
@@ -64,7 +83,7 @@ Deploy changes to the application UI:
64
83
npm run upload-site
65
84
```
66
85
67
-
Deploy changes to CloudFormation, Swagger, backend function, and the listener function:
86
+
Deploy changes to CloudFormation, Swagger, or lambda functions:
0 commit comments