Skip to content

rorads/qntm-exhib.rorads.github.io

Repository files navigation

Quantum Symbols Project

Overview

The Quantum Symbols project is a minimal and visually striking single-page application (SPA) that features a set of floating symbols inspired by quantum themes. The application is designed to be mobile-optimized and works seamlessly across all modern browsers, including Chrome, Edge, Safari, Opera, Brave, and Arc.

Features

  • Floating symbols that respond to user interactions.
  • Full-screen modal display for content when symbols are clicked.
  • Visually appealing background graphics that convey a quantum theme with undulating colors and rounded geometric shapes.
  • Built using TypeScript for robust and maintainable code.

Project Structure

The project is organized as follows:

├── src
│ ├── index.ts # Main entry point of the application
│ ├── styles.css # Styles for the application
│ ├── types.ts # TypeScript interfaces and types
│ └── assets
│ └── background.svg # Background graphic for the application
├── public
│ └── index.html # Main HTML file for the application
├── dist # Build output
| └── various files generated by webpack which are served publically
├── package.json # npm configuration file
├── tsconfig.json # TypeScript configuration file
├── .gitignore # Files and directories to ignore by Git
└── README.md # Documentation for the project

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/rorads/qntm-exhib.rorads.github.io.git
    cd qntm-exhib.rorads.github.io
    
  2. Install dependencies:

    npm install
    
  3. Build the project:

    npm run build
    
  4. Serve the application:

    npx serve -s dist -l 3005
    
  5. Open your browser and navigate to http://localhost:3005 to view the application.

The application is deployed and can be accessed at: https://rorads.github.io/qntm-exhib.rorads.github.io/dist/

Usage

  • Click on any of the floating symbols to open a modal that displays relevant content.
  • The application is designed to be responsive and should work well on mobile devices.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any suggestions or improvements.

License

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

About

Guiding people through an art exhibition

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published