🏡 Sweet Home Chrome Extension

Welcome to the installation guide for the Sweet Home Chrome extension. This extension sets a custom default page for your Chrome browser.

📋 Prerequisites

Before installation, ensure you have:

• Google Chrome Browser installed on your computer.

🛠 Installation Instructions

1. Download the Extension:

   • Click on the green Code button, then select Download ZIP.
     

2. Install the Extension in Chrome & getting started:

   • Open Google Chrome.
   • Type chrome://extensions in the address bar and press Enter.
     
   • Enable the Developer mode toggle at the top right corner.
     
   • Click on Load unpacked and select the unzipped folder of the downloaded extension files.
     
     
   • Open a new tab, hover to bottom right of your screen, and click on the settings icon.
     
   • Type in your name and press Save.
     
   • Confirm by clicking OK and it will save your name locally.
     

🚀 Usage

After installation, every new tab or window you open in Chrome will display the Sweet Home default page with your name. Enjoy your new browsing experience!

Pausing the Extension

If you wish to pause the extension, navigate to chrome://extensions and toggle the extension off.

🛠 Technologies Used

This project utilises the following technologies:

• JavaScript: For scripting and handling the extension's logic.
• CSS: For styling the extension's user interface.
• HTML: Used to structure the content displayed by the extension.

These languages work together to create a dynamic and visually appealing experience for the users of the Sweet Home extension.

APIs Used

The Sweet Home Chrome extension integrates several APIs to enhance functionality:

• OpenWeatherMap API: Utilised to fetch current weather data. OpenWeatherMap offers a variety of free APIs that provide weather information.
• API Ninja Quotes API: This API is used to fetch random inspirational quotes, adding a motivational aspect to the homepage.
• Unsplash API: Integrated to fetch high-quality, royalty-free images that dynamically change the background of the homepage.

These APIs contribute to a dynamic and personalised user experience by providing real-time data and diverse content.

🤝 Contributing

We welcome contributions to the Sweet Home Chrome Extension! Whether you're looking to fix bugs, add new features, or improve documentation, your help is appreciated. Here’s how you can contribute:

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please report them using the Issues tab on GitHub. Please check to see if an issue already exists before creating a new one. If one exists, feel free to add any additional comments or suggestions.

Submitting Changes

If you're ready to contribute code or documentation, please follow these steps:

1. Fork the Repository:

   • Start by forking the repository. This creates a copy of the code base on your GitHub account to work with.

2. Clone Your Fork:

   • Clone the forked repository to your local machine to make changes.

3. Create a New Branch:

   • Before making any changes, create a new branch in your clone. This keeps your adjustments separate from the main project, allowing for easier management of multiple contributions.

4. Make Your Changes:

   • Implement your fixes or enhancements and commit them to your branch. Make sure to write clear, concise commit messages that explain your changes.

5. Test Your Changes:

   • Ensure that your changes do not break any existing functionality and that they perform as expected. Adding tests to verify functionality is greatly encouraged.

6. Submit a Pull Request:

   • Push your changes to your fork on GitHub and then submit a pull request. In your pull request description, explain your changes and reference any related issue numbers.

Code Review

Once your pull request is submitted, it will be reviewed by the maintainers. During review, you may receive feedback or questions about your changes. This is a normal part of the process; responding promptly and making any necessary adjustments will help speed up the acceptance of your contribution.

Stay Updated

It's a good idea to pull in updates from the source repository regularly. This helps ensure your local copy is up to date and can reduce the chances of conflicts or other issues when you submit a pull request.

For First-Time Contributors

If you are a first-time contributor and are unsure how to perform these steps, head over to First Contributions. This resource provides a simple guide that explains the process of contributing to a project on GitHub step-by-step.