/RowdyMermaid

Website build for Rowdy Mermaid Kombucha.

Primary LanguageJavaScriptMIT LicenseMIT

Stories in Ready

Rowdy Mermaid

Repository for the Rowdy Mermaid Kombucha website.

Technologies Used:

Contributing

  • To initially begin working on the project, you'll need to first reach out to Charlie Beck on Slack to be added to the team.

  • Once you have been added to the team, clone the repository to your machine.

    • git clone
  • Next, you will need to install dependencies:

    • yarn
  • Now, you will need to build the code base using Gulp and launch the server.

    • gulp
  • Finally, to begin working on a particular issue, you'll need to branch off of the development branch, write the code to solve the issue, then submit a PR into the development branch. You should use the naming convention [issue-number]-[page]-[quick description].

    • git checkout -b [new branch name]
  • Once you have finished building a feature, you will need to submit a PR to the development branch and add Wesley Song, Charlie Beck, or Aaron Pennington to review.

    • git push origin [branch name]
    • On code page of repo, you can submit PR.

Page Structure:

  1. Landing Page aka Home Page -- this will be the page the home page of the website.

  2. Products -- This page will show all of Rowdy Mermaids current kombucha flavors.

  3. Social -- This page will display images and tweets from social media.

  4. About -- A section with description of Rowdy Mermaid.

  5. Taproom -- This page will show information about the taproom.

  6. Store -- This page will be a store front for patrons to purchase Rowdy Mermaid swag and products.