Skip to content

Minor improvements for local dev setup #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 13 commits into from
Closed

Minor improvements for local dev setup #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
74e5b97
Resolve main file
eps1lon Oct 8, 2020
bdb2173
Use strict SemVer syntax
eps1lon Oct 8, 2020
7602665
Remove files which is not used anyway
eps1lon Oct 8, 2020
90d6552
Document how to create the profile with the cli
eps1lon Oct 8, 2020
2982779
Update claudia access credentials
eps1lon Oct 8, 2020
dbd85a4
Update required policies
eps1lon Oct 8, 2020
3032fd4
Update information about working directory
eps1lon Oct 8, 2020
58d3636
Update docs/packages/feedback/README.md
eps1lon Oct 8, 2020
6d1b496
Apply suggestions from code review
eps1lon Oct 9, 2020
6af82ca
Restore files field
eps1lon Oct 9, 2020
02e675c
Merge branch 'docs-ratings' into docs-ratings-review1
eps1lon Oct 9, 2020
0c592f4
Fix wrong merge resolutions
eps1lon Oct 9, 2020
2960bf8
Merge branch 'docs-ratings' into HEAD
mbrookes Oct 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/packages/feedback/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ If you wish to deploy your own instance for testing, follow the steps below.

## Prerequisites

Create an AWS profile in ~/.aws/credentials called "claudia" with credentials corresponding to an IAM user with AWSLambdaFullAccess and IAMFullAccess policies.
Create an AWS profile in ~/.aws/credentials called "claudia" with credentials corresponding to an IAM user with AmazonAPIGatewayAdministrator, AWSLambdaFullAccess and IAMFullAccess policies.
You can do that with `aws configure --profile claudia`.

Create a table in DynamoDB, with a `string` partition key called `id`, and a sort key called `page`. You can do that from the DynamoDB web console, or using the AWS CLI command line. Here is an example command that will create the `feedback-dev` table with the minimal provisioned throughput:

Expand Down Expand Up @@ -41,13 +42,14 @@ The project includes an IAM access policy that will grant the lambda function ac

> ⚠️ When setting up for the first time, you will need to delete the included `claudia.json` file that is specific to the MUI installation. Alternatively, if making changes to the function that you intend to submit back, then to avoid inadvetantly commiting changes to `claudia.json`, use `--config` with each command to create and use a local config file, and exclude this file in your `~/.gitignore`.

To set this up, first [set up the credentials](https://github.com/claudiajs/claudia/blob/master/getting_started.md#configuring-access-credentials), then:
To set this up, first [set up the credentials](https://claudiajs.com/tutorials/installing.html#configuring-access-credentials), then:

1. run `yarn` to install the dependencies
2. run `yarn setup` to create the lambda project under the default name on AWS.
1. run `yarn install` (from the root workspace) to install the dependencies
1. Navigate into the directory of this README, e.g. `cd docs/packages/feedback`
1. run `yarn setup` to create the lambda function on AWS under the default name.
This will also ask you for a table name for development and production.
If you used the above AWS command, they will be `feedback-dev` and `feedback-dev` respectively.
3. Test the API with using the [example requests below](#testing)
1. Test the API using the [example requests below](#testing)

For subsequent updates, use the `npm run deploy` command.

Expand Down
8 changes: 4 additions & 4 deletions docs/packages/feedback/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "feedback",
"version": "1.0.0",
"description": "Store and retrieve page ratings and comments",
"main": "index",
"main": "./index.js",
"license": "MIT",
"author": "Material-UI Team",
"private": true,
Expand All @@ -18,11 +18,11 @@
"reconfigure": "claudia update --profile claudia --configure-db"
},
"dependencies": {
"claudia-api-builder": "^4",
"uuid": "3.3.2"
"claudia-api-builder": "^4.1.2",
"uuid": "^3.3.2"
},
"devDependencies": {
"claudia": "^5"
"claudia": "^5.12.0"
},
"optionalDependencies": {
"aws-sdk": "^2.766.0"
Expand Down
4 changes: 2 additions & 2 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5036,12 +5036,12 @@ [email protected], classnames@^2.2.5, classnames@^2.2.6:
resolved "https://registry.yarnpkg.com/classnames/-/classnames-2.2.6.tgz#43935bffdd291f326dad0a205309b38d00f650ce"
integrity sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==

claudia-api-builder@^4:
claudia-api-builder@^4.1.2:
version "4.1.2"
resolved "https://registry.yarnpkg.com/claudia-api-builder/-/claudia-api-builder-4.1.2.tgz#a44479ee44d41936c0bf68c2fe9c8d30f3f31daf"
integrity sha512-xXS9ew32KRJSMQGHMTEsvSkd1FTs9GK3JjiBIuxk9EJz2hubryrWiTzsJQvcVcfBYE0fb7bO+ZhH2/fqqG7Acg==

claudia@^5:
claudia@^5.12.0:
version "5.12.0"
resolved "https://registry.yarnpkg.com/claudia/-/claudia-5.12.0.tgz#774e05d00d29cb6064d19da1c0d4a4713f2836e0"
integrity sha512-ukgOGUNeIaU23xQB5r41AqGPAcq8bBd5LGz4Q880aRgGSW6VGHVMD/srsZcWM6mP4XKSmaofHzmJfoIXSmlJFg==
Expand Down