diff --git a/.github/.keep b/.github/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/README.md b/README.md index 802192f46..e62e5272a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,70 @@ -# GroupProjectTemplate -Please make sure to modify this readme file as well as the "about" property of the project! +# Project Overview: MERN Stack Web Application + +## Introduction + +This project is a modern web application built using the MERN stack, which includes MongoDB, Express.js, React.js, and Node.js. + +## Objectives + +The primary objectives of this web application are to: +- Provide a responsive and interactive user interface. +- Implement a scalable and secure back-end architecture. +- Ensure real-time data processing and efficient database management. +- Deliver a seamless and engaging user experience across different devices and platforms. + +## Tech Stack + +### MongoDB +- **Role**: NoSQL database for data storage. +- **Features**: Flexible schema, high availability, and scalability. + +### Express.js +- **Role**: Web application framework for Node.js. +- **Features**: Simplifies routing, middleware management, and request handling. + +### React.js +- **Role**: Front-end library for building user interfaces. +- **Features**: Component-based architecture, virtual DOM, and efficient UI rendering. + +### Node.js +- **Role**: JavaScript runtime for server-side scripting. +- **Features**: Non-blocking, event-driven architecture for high-performance applications. + +## Architecture + +### Front-End +- **Components**: Modular React components for a reusable and maintainable UI + +### Back-End +- **Server**: Express.js server handling API requests and business logic. +- **Database**: MongoDB for storing and managing application data. + +### Deployment +- **Hosting**: Deployed on Render cloud platform. +- **CI/CD**: Continuous Integration and Continuous Deployment pipelines for automated testing and deployment using GitHub + +## Installation and Setup + +### Prerequisites +- Node.js and npm installed on your machine. +- MongoDB server running locally or on a cloud instance. + +### Steps +1. **Clone the Repository** + ```bash + git clone https://github.com/BUMETCS673/seprojects-cs673olf24team5.git + ``` +2. **Navigate to Project Directory** + ```bash + cd PixelPeak + ``` +3. **Install Dependencies** + ```bash + npm install + ``` +4. **Start the Development Server** + ```bash + npm run dev + ``` +5. **Access the Application** + Open your browser and go to `http://localhost:3000`. diff --git a/doc/CS673_MeetingMinutes_Team5.docx b/doc/CS673_MeetingMinutes_Team5.docx new file mode 100644 index 000000000..721a81d13 Binary files /dev/null and b/doc/CS673_MeetingMinutes_Team5.docx differ diff --git a/doc/CS673_ProgressReport_Team5.xlsx b/doc/CS673_ProgressReport_Team5.xlsx new file mode 100644 index 000000000..5f4f1cccc Binary files /dev/null and b/doc/CS673_ProgressReport_Team5.xlsx differ diff --git a/doc/CS673_SPPP_RiskManagement_Team5.xlsx b/doc/CS673_SPPP_RiskManagement_Team5.xlsx new file mode 100644 index 000000000..628fdf0d7 Binary files /dev/null and b/doc/CS673_SPPP_RiskManagement_Team5.xlsx differ diff --git a/doc/CS673_SPPP_Team5.docx b/doc/CS673_SPPP_Team5.docx new file mode 100644 index 000000000..d50ada332 Binary files /dev/null and b/doc/CS673_SPPP_Team5.docx differ diff --git a/team.md b/team.md new file mode 100644 index 000000000..d0ba119c2 --- /dev/null +++ b/team.md @@ -0,0 +1,11 @@ +Hi, my name is Kenny Light and I currently live in Fort Myers, FL. I graduated with a degree in Management Information Systems from USF in 2000. I'm pursuing a masters degree in Software Development. I'm employed with U.S. Sugar as a Sr. Software Developer, primarely developing with c#, .net, Visual Studio, SQL Server, MVC, WPF, Jquery, Javascript, SSRS, HTML, and CSS. I'm almost finished with a laboratory information management system (LIMS) application. This application connects to sugar analysis devices, pulls final analysis, and saves to a database. I look forward to learning from my peers as well as the teachers/facilitators. + + +Hi, my name is Rich Frechette, I live in Boston, MA. I graduated from Penn State with BS in Electrical Engineering in 2019. I am pursuing a masters in Software Development with BU. I am a Product/Test Engineer for Analog Devices working on Radio Frequency Testing for semiconductor chips. I use LabVIEW and Python to develop automated tests utilizing external measurement and power supply equipment. In my previous role I developed similar automated testing using C#. + + +Hello, I am Abdallah El Hamawi, I currently lie in Seattle, WA. I am completeing my masters in Software Development. I have 4 courses left to graduate including this one. I decided to take a break for a year because my wife and I welcomed our baby daughter last fall. My background is mainly in union organizing and labor relations. I decided to persue this masters to expand on my expertise and to explore different career options later on. I look forward to working with you all! + +Hi, I'm Mateus Silva. I live near Boston, MA, and I graduated last year from Brandeis University with a BS in Computer Science. I'm pursuing the masters degree in Software Development as well. I currently work in Software Support for SAP LeanIX, a software company specializing in enterprise architecture management. I created a few small-scale Web applications in the past using Javascript as well as some projects in Java/Python, and dabbled a bit in front-end development using the React framework. I hope to learn a lot from everyone in this course! + +Hi! My name is Max Zink. I'm currently living in North Hollywood, CA. I graduated from Pepperdine in 2022 with a BS in Computer Science and a BA in Theatre. I am currently pursuing my masters in software development. Over the years, I've used C, C++, Java, Python, Prolog, R, and more recently, Javascript and SQL. A few projects I've completed include a compiler that translates assembly language into machine language, written in C++, and a Python-based .WAV player. Despite some gaps in my knowledge regarding C# and Javascript, I'm excited to learn from and with my teammates.