JavaScript

Project: Restaurant Page

JavaScript Course

Introduction

Let’s use what we’ve learned and take a chance to continue practicing DOM manipulation by dynamically rendering a restaurant homepage! By the end, we are going to be using JavaScript alone to generate the entire contents of the website!

Note: DOM elements should be created using JavaScript but styling can be done in a separate CSS file.

.gitignore

When working with packages that are installed with npm, you don’t need to track the contents of node_modules with git, nor push those files to GitHub. This is because the package.json file contains all the information, so that anyone can clone your project and install them on their machine with npm install.

You can make a .gitignore file in the root of the project, and by writing file or directory names in it, you can tell git what things you don’t want to track. It’s customary to add node_modules to .gitignore, since it can get really big.

When creating a new repo on GitHub there is an option to specify a .gitignore template. There are many templates out there that include common files and directories that are not typically tracked based on the type of project or language used. When looking for a template for JavaScript projects there is a node template that includes node_modules.

Assignment

  1. Start the project the same way you began the webpack tutorial project.
    1. Run npm init in your project directory to generate a package.json file.

    2. Run npm install webpack webpack-cli --save-dev to install webpack to the node_modules directory of your project.

    3. Create a src and dist directory with the following contents:

      1. An index.js file in src.

      2. An index.html file in src. This file will not need a script tag, because we’re using html-webpack-plugin, which automatically adds that in. You will also not need to link a CSS stylesheet as you should be importing it into your JavaScript and letting your webpack configuration handle bundling.

      3. Create a webpack.config.js file that looks just like our file from the Webpack “Getting Started” tutorial. Don’t forget to add the html-webpack-plugin config to your webpack.config.js and set its template option with a path to src/index.html.

  2. Create a .gitignore file in the root of your project. It should contain node_modules and dist on separate lines.

  3. Set up an HTML skeleton inside of src/index.html. Inside the body, add a <header> element that contains a <nav> with buttons (not links!) for different “tabs” (for example buttons for “Home”, “Menu” or “About” etc). Below the <header>, add a single <div id="content">.

  4. Inside of src/index.js write a console.log or alert statement and then run npx webpack. Load up dist/index.html in a browser to make sure everything is working correctly.

    • Quick tip: If you run npx webpack --watch you will not have to rerun webpack every time you make a change.
  5. Inside div#content, create a homepage for your restaurant. You might want to include an image, headline, and some text about how wonderful the restaurant is; you do not have to make this look too fancy. It’s okay to hard-code these into the HTML for now just to see how they look on the page.

  6. Now remove everything inside div#content from the HTML (so you still have the <header> and <nav> with an empty <div id="content"> below it) and instead create them by using JavaScript only, e.g. by appending each new element to div#content once the page is first loaded. Since we’re all set up to write our code in multiple files, let’s write this initial page-load function inside of its own module and then import and call it inside of index.js.

  7. Next, set up your restaurant site to use tabbed browsing to access the Contact and Menu pages. Look at the behavior of this student’s live preview site for visual inspiration.

    1. Put the contents of each ‘tab’ inside of its own module. Each module will export a function that creates a div element, adds the appropriate content and styles to that element and then appends it to the DOM.

    2. Write the tab-switching logic inside of index.js. You should have event listeners for each button in the header navbar that wipes out the current contents of div#content and then runs the correct ‘tab module’ to populate it with the new contents again.

  8. If you are using GitHub pages to host your completed page you need to do a tiny bit more work to get it to show up. After running webpack the full bundled version of your site is available in the dist folder, but GH pages is looking for an index.html in the root directory of your project.

    1. Follow the instructions on this gist about deploying your dist subdirectory to GitHub pages. EZPZ!
      • To prevent having to copy and paste the same lengthy git command each time, you can instead create an npm script to do the work for you!
        • Inside your project’s package.json file, within the scripts section, add an additional entry named something of your choosing and paste in the command from the above gist surrounded by quotation marks. Follow the formatting of the already added test script.
        • For Example:

          "scripts": { "YourScriptName": "git subtree push --prefix dist origin gh-pages" }

        • Now each time you need to update your project’s live preview, you npm run <YourScriptName> in your project’s terminal.
        • To learn more about this, here’s a short tutorial video on npm scripts.
    2. Recall that the source branch for GitHub Pages is set in your repository’s settings.

Support us!

The Odin Project is funded by the community. Join us in empowering learners around the globe by supporting The Odin Project!