Skip to content

Aswath20000/Juice-shop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 

Repository files navigation

OWASP Juice Shop

A React-based web application inspired by the OWASP Juice Shop, featuring a set of interactive challenges to explore and learn about common web application vulnerabilities. This project is ideal for practicing secure coding techniques and understanding real-world security issues in a safe, controlled environment.

Table of Contents

  1. Overview
  2. Prerequisites
  3. Setup Instructions
  4. User Interface
  5. Conclusion
  6. References

Overview

This project is a React-based clone of the OWASP Juice Shop, designed as a learning platform to practice web application security concepts. It features unique cyber security challenges that simulate real-world vulnerabilities, allowing users to explore and mitigate common security issues in a controlled environment.

Prerequisite

Before setting up the project, ensure the following tools and software are installed on your system:

  1. Node.js (v16 or later)

  2. Git

    • Download and install from the Git official site.
    • Verify installation:
      git --version
  3. MongoDB

    • Ensure you have MongoDB installed and running on your local machine or use a cloud-based service like MongoDB Atlas.
    • Verify installation (for local setup):
    mongo --version
  4. Code Editor (Optional but recommended)

  5. Browser

    • A modern web browser like Chrome, Firefox, or Edge for testing.

If your project involves a database or API, make sure the relevant services or tools (e.g., Docker, Postman) are also installed.

Setup Instructions

1. Clone the Repository

Download the project code to your local machine using Git:

git clone https://github.com/Aswath20000/Juice-shop
cd Juice-shop/owasp-juice-shop

2. Install Dependencies

Install the required packages using npm:

npm install
npm install crypto-js
cd backend
npm i

4. Start the Development Server

First, Run the development server with the following command:

cd backend
node server.js

Then for frontend

npm start

The application will be accessible at http://localhost:3000 in your browser.


5. Additional Configuration (Optional)

  • Challenges Setup: Modify challenge configurations located in the src/challenges/ directory as needed.
  • Database/API: If the project uses a backend or database, ensure those services are up and running before starting the app.

You are now ready to explore and use the application!

User Interface

The application is designed with a user-friendly interface that provides intuitive navigation and interactive features. Here's a breakdown of the main UI components:

1. Dashboard

The main landing page where users can browse and buy items, serving as the primary interaction hub.

Dashboard

2. Basket page

A simulated shopping cart where users can interact with purchased items.

Basket page

3. Score board

Tracks and displays the user's overall score and ranking among other participants.

Score board

Conclusion

This project serves as an engaging platform to learn and practice web application security through a React-based clone of the OWASP Juice Shop. By simulating real-world vulnerabilities and providing interactive challenges, it offers users a hands-on approach to understanding and mitigating common security issues. With its flexible design and customizable features, this project is not only a valuable educational tool but also a foundation for extending and exploring advanced security concepts.

References

  1. OWASP Juice Shop
    The official OWASP Juice Shop, which this project is based on. A vulnerable web application designed for security testing and learning.

  2. React Documentation
    The official React documentation, used as a reference for building the frontend of this project.

  3. Node.js Documentation
    Documentation for Node.js, which is used as the runtime environment for this application.

These resources provided the foundation for creating this web application and implementing security challenges for users to explore.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •