Initial commit

Author: ryansonshine

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -1,11 +1,33 @@
-## My Project
+# AWS CodeArtifact NPM Example
 
-TODO: Fill this README out!
+An example repository for creating, publishing, and installing npm packages
+using [AWS CodeArtifact](https://aws.amazon.com/codeartifact/)
 
-Be sure to:
+## Prerequisites
 
-* Change the title in this README
-* Edit your repository description on GitHub
+1. [Create an AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/)
+2. [Install and configure the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html)
+3. [Create a CodeArtifact repository](https://docs.aws.amazon.com/codeartifact/latest/ug/create-repo.html)
+
+## Getting Started
+
+### Find and replace the following
+
+1. `my-repo` with your CodeArtifact repository name
+2. `my-domain` with your CodeArtifact domain
+3. `us-east-1` with the region of your CodeArtifact repository
+4. `<ACCOUNT ID>` with your AWS account ID
+5. `@myorg` with your org name
+
+### Publish `my-package`
+
+To publish `my-package`, change your working directory to [./my-package](./my-package)
+and run `npm publish`
+
+### Install from `my-app`
+
+To install your new package, change your working directory to [./my-app](./my-app)
+and run `npm install`
 
 ## Security
 
@@ -14,4 +36,3 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform
 ## License
 
 This library is licensed under the MIT-0 License. See the LICENSE file.
-

my-app/index.js

@@ -0,0 +1,12 @@
+/*
+ * Copyright Amazon.com, Inc. and its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License. See the LICENSE accompanying this file
+ * for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+const { helloWorld } = require("@myorg/my-package");
+
+helloWorld();

my-app/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "my-app",
+  "version": "1.0.0",
+  "description": "A sample application consuming a private scoped npm package",
+  "main": "index.js",
+  "scripts": {
+    "prepare": "npm run co:login",
+    "co:login": "aws codeartifact login --tool npm --repository my-repo --domain my-domain"
+  },
+  "dependencies": {
+    "@myorg/my-package": "^1.0.0"
+  }
+}

my-package/index.js

@@ -0,0 +1,12 @@
+/*
+ * Copyright Amazon.com, Inc. and its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: MIT
+ *
+ * Licensed under the MIT License. See the LICENSE accompanying this file
+ * for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+module.exports.helloWorld = function () {
+  console.log("Hello world!");
+};

my-package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@myorg/my-package",
+  "version": "1.0.0",
+  "description": "A sample private scoped npm package",
+  "main": "index.js",
+  "scripts": {
+    "prepare": "npm run co:login",
+    "co:login": "aws codeartifact login --tool npm --repository my-repo --domain my-domain"
+  }
+}