# awsome
> AWS Object Management Environment
Latest version **1.4.0** (published 2020-04-13) · MIT license · 0 weekly downloads
## Install
```sh
npm install awsome
pnpm add awsome
yarn add awsome
bun add awsome
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.4.0 |
| Published | 2020-04-13 |
| First published | 2015-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.10 |
| Dependencies | 7 |
| Unpacked size | 2.3 MB |
| Known vulnerabilities | 0 (+3 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 21 |
| Author | I. Dan Calinescu |
| Maintainers | idancali |
| Keywords | aws, s3, route53, route53Domains, static, website, hosting, bucket, domain |
## Links
- npm: https://www.npmjs.com/package/awsome
- Repository: https://github.com/fluidtrends/awsome
- Issues: https://github.com/fluidtrends/awsome/issues
- npm.io page: https://npm.io/package/awsome
## Dependencies (7)
- [uuid](https://npm.io/package/uuid.md) ^3.4.0
- [walk](https://npm.io/package/walk.md) ^2.3.14
- [tldjs](https://npm.io/package/tldjs.md) ^2.3.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.648.0
- [shortid](https://npm.io/package/shortid.md) ^2.2.15
- [fs-extra](https://npm.io/package/fs-extra.md) ^5.0.0
- [@aws-amplify/cli](https://npm.io/package/@aws-amplify/cli.md) ^4.17.2
## Alternatives
- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads
## Recent versions
- 1.4.0 (latest) — 2020-04-13
- 1.3.1 — 2020-04-07
- 1.3.0 — 2020-04-04
- 1.2.0 — 2020-03-30
- 1.1.0 — 2020-03-28
- 1.0.0 — 2020-03-28
- 0.6.0 — 2019-02-22
- 0.5.0 — 2019-02-20
- 0.4.2 — 2018-11-08
- 0.4.1 — 2018-11-08
- 0.4.0 — 2018-11-08
- 0.3.0 — 2018-02-02
- 0.2.5 — 2018-02-02
- 0.2.4 — 2018-02-01
- 0.2.3 — 2018-01-22
- … 9 more at https://npm.io/package/awsome/versions
## README
AWSome
AWS Object Management Environment
Manage your AWS infrastructure as if it were composed of plain objects.
## Build Status [](https://circleci.com/gh/fluidtrends/awsome)
[](https://codeclimate.com/github/fluidtrends/awsome/test_coverage)
[](https://codeclimate.com/github/fluidtrends/awsome/maintainability)
[](http://standardjs.com)
## Getting Started
Make your AWS credentials available in the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables and then just import AWSome to get started.
```javascript
// Import AWSome
const awsome = require('awsome')
// Create a new bucket instance
const bucket = new awsome.Bucket({ name: 'my-test-bucket' })
// Fetch the bucket data
bucket.retrieve()
.then((data) => {
// Good stuff, enjoy the data
})
.catch((error) => {
// Something happened and the bucket data could not be retrieved
})
```
## Examples
Get started with the examples provided to **create**, **retrieve**, **update** or **delete** buckets and to **host**, **unhost** domains as well as to **link** and **unlink** domains and buckets. Make sure you have your AWS key and secret ready.
```bash
node ./node_modules/awsome/examples key= secret= example=create-bucket
```
The supported examples are:
* [```create-bucket``` Creating a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/create-bucket.js)
* [```retrieve-bucket``` Retrieving a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/retrieve-bucket.js)
* [```update-bucket``` Updating a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/update-bucket.js)
* [```delete-bucket``` Deleting a bucket](https://github.com/fluidtrends/awsome/blob/master/examples/delete-bucket.js)
* [```host-domain``` Hosting a domain](https://github.com/fluidtrends/awsome/blob/master/examples/host-domain.js)
* [```unhost-domain``` Unhosting a domain](https://github.com/fluidtrends/awsome/blob/master/examples/unhost-domain.js)
* [```link-bucket``` Linking bucket to a domain](https://github.com/fluidtrends/awsome/blob/master/examples/link-bucket.js)
* [```unlink-bucket``` Unlinking a bucket from a domain](https://github.com/fluidtrends/awsome/blob/master/examples/unlink-bucket.js)
[See All The Examples](/examples)
## Tutorials
There is a detailed [Getting Started](tutorials/start) tutorial that you can read to set your AWS account up, to install and to start using AWSome right away.
Have a look at [all the tutorials available](tutorials) to make the most of AWSsome.
## Documentation
AWSome is very well documented and all objects, options, fields and functions are well explained and they all include examples.
Read the full documentation for detailed instructions on how to create, retrieve, update and delete buckets, including site buckets, host and unhost domains and link and unlink domains and buckets.
[Read The Docs](/docs)
## Contributing
We'd be glad to have you join us as an AWSome Contributor. Get started by reading our Contributor Guide.
[Read The Contributor Guide](/contrib)
## Dependencies
AWSome makes use of the following libraries:
* [aws sdk](https://github.com/aws/aws-sdk-js) - for AWS calls
* [cross-env](https://github.com/kentcdodds/cross-env) - for running examples
* [fs-extra](https://github.com/jprichardson/node-fs-extra) - for file management
* [walk](https://github.com/Daplie/node-walk) - for file tree walking
* [uuid](https://github.com/kelektiv/node-uuid) - for generating hosted zone references
* [tldjs](https://github.com/oncletom/tld.js) - for parsing domain names
* [savor](https://github.com/fluidtrends/savor) - for testing
## License
AWSome is licensed under the MIT License.
* [Read The License](LICENSE)
## Sponsors
AWSome is sponsored by [Fluid Trends](http://fluidtrends.com) and is part of the Fluid Trends Open Source Lab.
If you'd like to co-sponsor this project, please email your co-sponsorship request to **team at fluidtrends.com**
---
_Source: https://npm.io/package/awsome · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._