Kenzie On the Rocks

► INSERT-TEXT-HERE

Developed with the software and tools below.

Table of Contents

• Overview
• Features
• Repository Structure
• Getting Started
  • Installation
  • Usage
  • Tests
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

KenzieOnTheRocks is a Java/AWS drink recipe sharing platform, originally developed as a capstone project for the Kenzie Academy ATA Program. This project is now maintained to keep skills sharp and provide a learning resource for new developers.

Features

• User Authentication: AWS Cognito for secure user login and registration.
• Recipe Management: CRUD operations for drink recipes using AWS DynamoDB.
• Image Storage: AWS S3 integration for storing recipe images.
• Serverless Architecture: AWS Lambda functions for backend logic.
• CI/CD Pipeline: Automated deployment using custom scripts.

---

Repository Structure

└── \Users\sydor\Kenzie\KenzieOnTheRocks/
    ├── .github
    │   ├── .keep
    │   └── workflows
    ├── Application
    │   ├── build
    │   ├── build.gradle
    │   └── src
    ├── Application-template.yml
    ├── build.gradle
    ├── buildScripts
    │   ├── buildspec.yml
    │   ├── CICDPipeline-Capstone.yml
    │   ├── integrationspec.yml
    │   └── runIntegrationTests.sh
    ├── buildSrc
    │   ├── build.gradle
    │   └── src
    ├── cleanupDev.sh
    ├── cleanupPipeline.sh
    ├── createPipeline.sh
    ├── deployDev.sh
    ├── fix-yarn-build-unit-4.patch
    ├── Frontend
    │   ├── build.gradle
    │   ├── package-lock.json
    │   ├── package.json
    │   ├── src
    │   ├── webpack.config.js
    │   └── yarn.lock
    ├── gradle
    │   └── wrapper
    ├── gradlew
    ├── gradlew.bat
    ├── IntegrationTests
    │   ├── build.gradle
    │   └── src
    ├── lambda-service-development.yml
    ├── LambdaExampleTable.yml
    ├── LambdaService-template.yml
    ├── local-dynamodb.sh
    ├── README.md
    ├── runLocalRedis.sh
    ├── ServiceLambda
    │   ├── build.gradle
    │   └── src
    ├── ServiceLambdaJavaClient
    │   ├── build.gradle
    │   └── src
    ├── ServiceLambdaModel
    │   ├── build.gradle
    │   └── src
    ├── settings.gradle
    ├── setupEnvironment.sh
    ├── UserTable.yaml
    ├── Utilities
    │   ├── ATACheckstyle
    │   ├── bin
    │   ├── build.gradle
    │   └── src
    └── yarn.lock

---

Getting Started

System Requirements:

• Java: version x.y.z

Installation

From source

1. Clone the KenzieOnTheRocks repository:

$ git clone https://github.com/jSydorowicz21/KenzieOnTheRocks.git

2. Change to the project directory:

$ cd ./KenzieOnTheRocks

3. Install the dependencies:

$ mvn clean install

Usage

From source

Overview

To deploy the Development Environment

Run ./deployDev.sh

To tear down the deployment then run ./cleanupDev.sh

To deploy the CI/CD Pipeline

Fill out setupEnvironment.sh with the url of the GitHub repo and the username (in all lowercase) of the team member who is maintaining the repo. Confirm that the team member has added your username as a contributor to the repo.

Run ./createPipeline.sh

To teardown the pipeline, run ./cleanupPipeline.sh

---

Current Backlog

https://github.com/jSydorowicz21/KenzieOnTheRocks/issues

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the \Users\sydor\Kenzie\KenzieOnTheRocks project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your local account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/jSydorowicz21/KenzieOnTheRocks.git

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to local: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

Acknowledgments

• TODO: Fill out

Return

---