Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sugam-arora/zomeal

Welcome to Zomeal, your ultimate culinary guide! Discover the finest eateries and hidden gems in your city with Zomeal. Whether you're craving a quick bite or a gourmet experience, Zomeal connects you to flavors that delight and dishes that inspire. Embark on a delicious journey with us and elevate your dining adventures!
https://github.com/sugam-arora/zomeal

devops devsecops devsecops-pipeline docker git jenkins kubernetes nodejs npm owasp sonarqube trivy zomato zomatoclone

Last synced: 2 months ago
JSON representation

Welcome to Zomeal, your ultimate culinary guide! Discover the finest eateries and hidden gems in your city with Zomeal. Whether you're craving a quick bite or a gourmet experience, Zomeal connects you to flavors that delight and dishes that inspire. Embark on a delicious journey with us and elevate your dining adventures!

Awesome Lists containing this project

README

        

# Zomeal: Where Culinary Delight Meets Cutting-Edge Security and Deployment

![Build, Analyze, Scan](https://github.com/SUGAM-ARORA/Zomeal/actions/workflows/deploy.yaml/badge.svg)

Welcome to **Zomeal**, an advanced DevSecOps project designed to clone Zomato with enhanced security and deployment capabilities. Leveraging cutting-edge technologies like React, Node.js, Docker, Kubernetes, GitHub Actions, SonarQube, Trivy, Jenkins, and OWASP principles, Zomeal ensures a seamless, secure, and scalable dining experience.

## Table of Contents

1. [Project Overview](#project-overview)
2. [Tech Stack](#tech-stack)
3. [Features](#features)
4. [Installation](#installation)
5. [Usage](#usage)
6. [Available Scripts](#available-scripts)
7. [Security and Testing](#security-and-testing)
8. [CI/CD Pipeline](#cicd-pipeline)
9. [Build Details](#build-details)
10. [Learn More](#learn-more)
11. [License](#license)

## Project Overview

**Zomeal** is your ultimate culinary guide, designed to provide a seamless experience for discovering eateries and hidden gems. With a focus on security, continuous integration, and high performance, Zomeal aims to revolutionize the way you explore and enjoy food.

## Tech Stack

- **Frontend:** React
- **Backend:** Node.js
- **Containerization:** Docker
- **Orchestration:** Kubernetes
- **CI/CD:** GitHub Actions
- **Code Quality:** SonarQube
- **Vulnerability Scanning:** Trivy
- **Automation:** Jenkins
- **Security:** OWASP

## Features

- **Create React App:** Bootstrapped for easy setup and development.
- **Containerization:** Docker ensures consistent environments across different stages.
- **Orchestration:** Kubernetes for managing and scaling clusters.
- **Continuous Integration and Deployment:** Automated pipelines with GitHub Actions.
- **Code Quality and Security:** Integrated SonarQube and Trivy for robust scanning.
- **OWASP Compliance:** Adherence to top security practices for web applications.

## Installation

Clone the repository:
```bash
git clone https://github.com/SUGAM-ARORA/Zomeal.git
cd Zomeal
```

Install dependencies:
```bash
npm install
```

## Usage

### `npm start`

Runs the app in development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

## Available Scripts

### `npm run eject`

Ejects the app for full control over configuration files and dependencies.

### Additional Scripts

- **Code Splitting:** [Learn More](https://facebook.github.io/create-react-app/docs/code-splitting)
- **Analyzing the Bundle Size:** [Learn More](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
- **Making a Progressive Web App:** [Learn More](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
- **Advanced Configuration:** [Learn More](https://facebook.github.io/create-react-app/docs/advanced-configuration)
- **Deployment:** [Learn More](https://facebook.github.io/create-react-app/docs/deployment)
- **Troubleshooting `npm run build` Fails to Minify:** [Learn More](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

## Security and Testing

- **SonarQube:** Scans code for vulnerabilities and code smells.
- **Trivy:** Checks Docker images for vulnerabilities.
- **OWASP Compliance:** Ensures adherence to top security practices.

## CI/CD Pipeline

- **GitHub Actions:** Automated workflows for continuous integration and deployment.
- **Jenkins:** Used for advanced automation tasks.
- **SonarQube and Trivy:** Integrated into the pipeline for continuous security checks.

## Build Details

[![Build, Analyze, Scan](https://github.com/SUGAM-ARORA/Zomeal/actions/workflows/deploy.yaml/badge.svg)](https://github.com/SUGAM-ARORA/Zomeal/actions/workflows/deploy.yaml)

- **Build Status:** Automatically triggered on push and pull request events.
- **Analysis:** Runs SonarQube analysis for code quality.
- **Scanning:** Utilizes Trivy for vulnerability scanning.

## Learn More

- [React Documentation](https://reactjs.org/)
- [Create React App Documentation](https://facebook.github.io/create-react-app/docs/getting-started)
- [Docker Documentation](https://docs.docker.com/)
- [Kubernetes Documentation](https://kubernetes.io/docs/home/)
- [GitHub Actions Documentation](https://docs.github.com/en/actions)
- [SonarQube Documentation](https://docs.sonarqube.org/)
- [Trivy Documentation](https://aquasecurity.github.io/trivy/)

## License

This project is licensed under the MIT License.