AWS Simple Storage Services (S3)

AWS Simple Storage Services (S3) resources for the self-hosted domain: clemans.net.
Explore the docs

View Demo • Report Bug • Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Deployment
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

The infrastructure within this project is built exclusively on the AWS Cloud Development Kit (AWS CDK).

Built With

Below are the major frameworks/libraries used to bootstrap this project.

• 
• 
• 
• 
• 

(back to top)

Getting Started

For a manual deployment, follow the below instructions and prerequisites.

Prerequisites

*Install the latest version of Node.js and NPM using the Node version manager 'NVM'.

• NPM

  curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh |
  bash && source ~/.nvm/nvm.sh &&
  nvm install node

• AWS-CDK

  npm install --global aws-cdk
  cdk bootstrap --profile <profile_name>

Deployment

The below steps will guide you on successfully deploying your AWS CloudFormation stack(s).

1. Confirm your AWS Credentials are configured. More info at: Configure the AWS CLI

2. Clone the repo

   git clone https://github.com/clemans/net.clemans.Storage.git

3. Configure .env & config/parameters.ts files relative to your own setup.

4. Install NPM packages

   npm install

5. Deploy the AWS CDK CloudFormation stack(s)

   npm run start

6. Destroy the AWS CDK CloudFormation stack(s)

   npm run destroy

(back to top)

Roadmap

TO DO	Description	Status
Unit Coverage	Adds Jest Unit Test support	✅
GitHub Actions	Continuous integration and project automation	📝 WIP

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo & create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Create your Feature Branch (git checkout -b feature/jira-issue)
2. Commit your Changes (git commit -m 'Add some AmazingFeature')
3. Push to the Branch (git push origin feature/jira-issue)
4. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Open a GitHub Issue.

Acknowledgments

Thanks to all the projects and services to making this possible:

• Choose an Open Source License
• Img Shields

(back to top)