Code Monkey home page Code Monkey logo

javascript-final-project's Introduction

[TODO: Replace with your Netflify status badge]

๐Ÿฅ๐Ÿฐ JavaScript Project for Mayme's Bakery ๐Ÿช๐Ÿฉ

๐Ÿž Who is Mayme's Bakery? ๐ŸŽ‚

Mayme's Bakery is a family-owned business whose scrumptious baked goods have been enjoyed worldwide. ๐ŸŒ They'd love to see their baking history brought to life in an online interactive timeline. ๐Ÿ“œ

๐Ÿง‘๐Ÿพโ€๐Ÿ’ป Getting Started ๐Ÿš€

  1. Fork this Repository ๐Ÿด: Start by making a copy of this repository in your own GitHub account using the "Fork" button at the top right of this page. Only one person per group needs to do this.

  2. Add Your Teammates ๐Ÿ‘ฅ: From your forked repository, add your fellow group members as contributors under the "Settings" tab. Just click on "Manage Access", "Invite a collaborator", and then enter their GitHub usernames.

  3. Clone the Repository ๐Ÿ’ป: After you've set up the repository, you'll need to clone it to your local machine. You can do this by clicking the "Code" button and copying the URL. Then, open your terminal, navigate to where you want to keep the project and run git clone <URL>.

๐ŸŽฏ Your Mission, Should You Choose to Accept It ๐Ÿ•ต๐Ÿพโ€โ™€๏ธ

You and your study group will work as an agile team to create an animated, interactive timeline for Mayme's Bakery. The interactivity of the timeline should be agreed upon by all group members.

๐Ÿ“š User Stories

  1. As a user, I want to see the summary of each historical item in a summary card, so that I can see a brief introduction of each historical item.
  2. As a user, I want to see the summary cards in a timeline in date order, so that I can see a brief history (in date order) in one place.
  3. As a user, I want to see more details on a particular item in a modal so that I can see the full information (including an image).
  4. As a user, I want to dismiss the full details of a single historical item, so that I can return to the timeline.
  5. As a developer, I want to deploy the changes made to the timeline, so that the timeline can be viewed publicly.

๐Ÿ“ Starter Files ๐Ÿ“‚

We have provided two files to get you started:

  1. index.html
  2. js/data.js

HTML ๐Ÿ–ฅ๏ธ

The provided index.html includes:

<script type="module" src="js/index.js"></script>

Having type="module" means you can the ES6 feature modules (refer to the slides for a reminder of what modules are). src="js/index.js" indicates your main javascript file must be named index.js within the js directory.

Data ๐Ÿ“Š

We have provided an array of objects with the data that should be displayed in your timeline. This data can be found in the js/data.js file and must be imported into your js/index.js so you can use it. If you choose, you can add more data to the file, but this is the minimum amount of data you must display in your timeline.

๐Ÿ“ˆ Project Criteria ๐Ÿ“‰

The only HTML you should add to the body is in step 1. Everything else should be done in JavaScript.

  1. In your HTML file add a <div> with the class name timeline.
  2. Loop over the provided array of objects to create to the summary card of each timeline item with:
    1. A div with the class name timeline-item. This div is your container for your summary card and everything for the summary card must be inside of it. Inside the div should be:
      1. h2 with the class name timeline-item-title. The title of each timeline item needs to be here
      2. span with the class name timeline-item-date. This should have the date of each timeline item
      3. The element that displays the summary text must have the class name timeline-item-summary
      4. The element that opens the modal so that a visitor can see full information must have the class name timeline-item-more-info
  3. Inside the modal (where the full information should be displayed) you must include the following:
    1. The container div must have the id modal-container
    2. The date must have the id modal-date
    3. The title must have the id modal-title
    4. The image must have the id modal-image
    5. The full description must have the id modal-full-description
    6. The element that closes the modal must have the id modal-close-button
  4. Create an external stylesheet here css/main.css (see CSS for more info)
  5. Deployed to Netlify and your site's status badge added to this file (README.md)

CSS ๐ŸŽจ

All styling (CSS) is completely up to you, but must be in a folder named css with a primary stylesheet called main.css.

๐Ÿ“ค How to Submit ๐Ÿ“ฅ

You must push all the code to your group project repo.

๐Ÿ’ก Finally ๐ŸŽ‰

Don't forget to ask for help if you need it, and have fun coding! ๐Ÿฅณ

๐Ÿ“š If you encounter any problems or have any questions, don't hesitate to ask in our GitHub Discussions.

javascript-final-project's People

Contributors

tanyapowell avatar dependabot[bot] avatar efuaakum avatar genyus avatar

Stargazers

RBK avatar Sara O'Connor 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.