AWSome

Real-Time AWS EC2 Instance Monitoring Tool

Table of Contents

1. About The Project
2. Technologies Used
3. Getting Started
4. Usage
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

AWSome is a real-time AWS EC2 instance monitoring tool designed to provide comprehensive insights into your EC2 instances using AWS CloudWatch. The project integrates with various AWS services such as Cognito for user authentication, IAM roles for permissions, and EC2 for instance management. The tool offers an interactive user interface built with React, allowing users to view EC2 instance metrics, generate heat maps, and analyze trends.

Key Features:

• Real-time EC2 instance monitoring
• Interactive visualizations using heat maps and graphs
• Customizable thresholds and alarms for memory usage and CPU load
• Secure user authentication with AWS Cognito
• User-friendly interface built with React and Redux

Built With

This project uses several technologies to provide a full-stack solution for AWS EC2 monitoring:

• - Frontend framework for building interactive UIs
• - User authentication and authorization
• - Cloud computing platform for running instances
• - Monitoring and logging service
• - Identity and access management
• - State management for React

(back to top)

Getting Started

If you'd like to learn more visit our website here Website

If you'd like to use our app you can visit the following link below. AWSome Tool

Otherwise, if you'd like to contribute to our product you can follow the steps below to get the development environment started!

Installation

//steps on accessing our deployed app, and our landing page

Prerequisites

• Node.js
• AWS access
• NPM
• Docker

(back to top)

Usage

AWSome provides an intuitive interface for managing and monitoring your EC2 instances. You can:

• View EC2 instance metrics such as CPU usage, memory load, and disk I/O in real-time.
• Set custom alarms to get notified when instance thresholds are exceeded.
• Use trend analysis to visualize your AWS EC2 instance performance.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add support for viewing EC2 instance performance metrics in real-time
• Integrate AWS CloudWatch for detailed metrics visualization
• Add authorization for a user to view their own metrics
• Add Dark Mode
• Improve UI responsiveness and accessibility

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

(back to top)

Contributing ## Contributing

We welcome contributions from the open-source community! Here's how you can contribute to AWSome:

🚀 Contributing to Our AWS Monitoring Tool

We ❤️ contributions from the community! Follow these steps to get involved:

1️⃣ Fork the Repo

Click the "Fork" button at the top-right corner of this page to create your own copy.

2️⃣ Create a Feature Branch

git checkout -b feature/yourNewFeatureName

3️⃣ Build Something Awesome 🛠️

• Implement Your Feature: Add your code, tests, or documentation.
• Ensure Your Changes Align with the Project's Goals: Make sure your work fits the overall vision.
• Keep Your Implementation Clean, Modular, and Well-Documented: Strive for readable, reusable, and well-commented code.

4️⃣ Commit Your Changes ✅

git commit -m "✨ Added [your-new-feature-description]"

5️⃣ Push to Your Branch 🚀

git push origin feature/yourNewFeatureName

6️⃣ Open a Pull Request (PR) 🔄

• Navigate to your fork on GitHub.
• Click "New Pull Request" and select the dev branch as the base (unless otherwise specified).
• Provide a detailed description of your changes.
• Submit the PR and wait for our team to review it.

7️⃣ Celebrate! 🎉

Once approved, your contribution will be merged into the project. Thank you for helping us improve this tool for developers!

💡 Need help? Feel free to open an issue or reach out to us in discussions! 🚀

(back to top)

License

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

(back to top)

Top contributors:

Jayson Sanon 💼 💻

Jose Andrew 💼 💻

Christina Abraham 💼 💻

Elijah Egede 💼 💻

Nathalie Owusu 💼 💻

Contact

Feel free to contact us with any questions or suggestions:

• Jayson: 💼 Jaysonsanon@gmail.com
• Jose: 💼 Joseandrew@live.com
• Christina: 💼 Christinajabraham@yahoo.com
• Elijah: 💼 Eegede22@gmail.com
• Salem: 💼 Nathalieowusudev@gmail.com

(back to top)

Acknowledgments

Special thanks to the following resources:

• AWS Documentation
• React Documentation
• Redux Documentation
• AWS CloudWatch Documentation
• Choose an Open Source License

Highlights:

• Technologies: React, AWS (Cognito, CloudWatch, EC2), Redux, IAM Roles
• Project Features: EC2 instance monitoring, CloudWatch visualizations, real-time analytics
• Usage: Setting up AWS credentials and visualizing EC2 instance metrics
• Roadmap: List of future features like automated scaling recommendations and email/SMS notifications