#Clausville Creative

This is a frontend from scratch project for a fictional museum. The goal of this project is to create a website that is responsive and accessible. The website is supposed to take the user to a different world and make them feel like they are in a museum. We built the website to take on some new challenges, such as learn a new JavaScript Library (Three.js) and firebase to host a website. We had a lot of fun building this website and we hope you enjoy it!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Some things about this project: We had a little less than 2 weeks to complete this project. There were some challenges that we faced, such as creating in a 3D space. We felt happy with the outcome of the project and we hope you enjoy it as well!

(back to top)

Built With

• Vite
• Three.js
• Firebase
• JavaScript
• HTML
• CSS
• GSAP

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Some things you will need to install to run this project:

• npm

  npm install npm@latest -g

• Vite

  npm install -g create-vite-app

• Three.js

  npm install three

• Firebase

  npm install firebase

• GSAP

  npm install gsap

Installation

1. Clone the repo

   git clone

2. Install NPM packages

   npm install

3. Run Vite

   npm run dev

4. Open your browser and go to localhost:3000

   http://localhost:3000/

OR

1. Go to the website

   https://museum-of-the-imagination.web.app/

(back to top)

Usage

This project can be used to learn about three.js and firebase. It can also be used to learn about how to create a website from scratch. Feel free to use this project as a template for your own website! Reach out to us if you have any questions!

(back to top)

Roadmap

• Add more exhibits
• Add more animations to the exhibits
• Add a better detailed gift shop
• Polish up transitions
• Add button to change music
• Add an API to gather images from a real museum

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Shadi Shwiyat - Github-Link

Robert Farley - Github-Link Personal Website

Project Link: https://github.com/Nomad-Rob/Museum_of_the_Imagination

(back to top)