Code Monkey home page Code Monkey logo

evolution's Introduction

Virtual Fish Tank - Frontend

Welcome to the Virtual Fish Tank project! This repository contains the frontend of an interactive fish tank simulation that allows users to observe virtual fishes in a dynamic environment. The frontend is designed to provide a visually appealing user interface, complete with background music and real-time updates from the backend server.

Table of Contents

  • Introduction
  • Features
  • Setup
  • Usage
  • File Structure
  • Technologies Used
  • License

Introduction

The Virtual Fish Tank project is an interactive simulation where users can observe virtual fishes in a simulated environment. The frontend handles the rendering of the simulation, user controls, and audio management. It connects to a backend server to receive real-time updates on the state of the simulation, ensuring that users are always viewing the most current state of the virtual tank.

You can view the live simulation at the following link:

Live Simulation

Features

  • Interactive Simulation: Observe fishes as they move, grow, and interact with each other and their environment.
  • Responsive Design: The UI adapts to various screen sizes and devices, providing a seamless experience across platforms.
  • Dynamic Background Music: The simulation includes background music that users can control, enhancing the immersive experience.
  • Real-time Updates: The frontend communicates with the backend server to receive and display real-time updates on the simulation’s state.

Setup

Follow these steps to set up the project locally:

  1. Clone the Repository: git clone https://github.com/yourusername/virtual-fish-tank-frontend.git

  2. Navigate to the Project Directory: cd virtual-fish-tank-frontend

  3. Install Dependencies: Ensure you have Node.js installed, then run: npm install

Usage

To start the frontend server and view the simulation in your browser:

  1. Start the Development Server: npm start

  2. Open the Simulation in a Browser: Navigate to http://localhost:3000 to view the simulation.

File Structure

The repository is structured as follows:

virtual-fish-tank-frontend/ ├── index.html # The main HTML file that includes the structure of the web page ├── style.css # Styles for the simulation UI ├── music.js # Handles background music logic and controls ├── script.js # Main script for managing the updates that comes to the backend ├── assets/ # Directory containing images, audio files, and other assets │ ├── imgs/ │ └── music/ └── package.json # Project metadata and dependencies

Technologies Used

  • HTML5: For the structure of the web page.
  • CSS3: For styling and layout.
  • JavaScript (ES6+): For dynamic content, state management, and interactivity.
  • PIXI.js: For rendering 2D graphics in the simulation.
  • WebSockets: For real-time communication with the backend server.
  • Node.js & npm: For dependency management and development tooling.
License

This project is licensed under the MIT License. See the LICENSE file for details.

evolution's People

Contributors

javierespinosap avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.