🥂 Kayti and Jake's Wedding Website

✅ Onboarding to the App

This is a React app that was creating by Vite.

• To run the app in a development environment, clone the repository and run yarn
• To spin up a local server run the command yarn dev
• The application will run locally at http://localhost:5173/

🤝 Application Dependencies

All dependencies are installed with yarn.

• React Tailwind
• Flowbite React
• React router dom
• React anchor link smooth scroll
• PDF Download
• React Hook Form
• EmailJS
• React Icons

🗄️ Useful Resources

A few of the many resources that helped me on my way.

• React Router Scroll to Top
• Scroll Button
• Embed a Google Map
• React Suspense Hook
• How to Create Forms in React using react-hook-form
• Simple React Contact Form Without Back-End

💄 Styling Notes

• Styling is handled with Tailwind
  • Tailwind classnames will format on save
• Fonts
  • Header font is Moontime located in public/fonts and configured in index.css
  • Can be referenced in Tailwind as font-moontime
  • Body font is Garamond located in public/fonts and configured in index.css
  • Can be referenced in Tailwind as font-garamond
• Font color: black #121F32
• Accent color: gold #B2935B
• Error: #CC0000
• Champagne: #f7E7CE
• Charcoal gray: #6C6868
• Light Gray: #C4C2C2
• Poppy: #CA4E46
• Bright Gold: #ECBB80

✨ Inspiration

• Examples of Beautiful Wedding Websites
• Our Dumb Wedding Site
• Chris & Jessica
• Danielle & Bradford

🫧 Linting

To check for linting errors in the entire project:

yarn eslint .

To check for linting errors in a single file:

yarn eslint <filename>

To fix most lint issues within the project:

yarn eslint . --fix

To fix most lint issues within a single file:

yarn eslint <filename> --fix

🚀 Deployment

• The application is deployed on Render.com and available at this url

⚙️ Testing

• The structure of this app requires Vitest, Jest, and React Testing Library
• Testing configs are a WIP

web_test:
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-node@v4
      with:
        node-version: "20"

    - name: Restore workspace cache
      uses: actions/cache@v3
      with:
        path: "**/node_modules"
        key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}

    - name: Install dependencies
      run: yarn

    - name: Run unit tests
      run: yarn test