Developer Guide for WWRG Website

Welcome to the WWRG website project! This guide provides instructions for developers on how to set up the project, make changes, and collaborate effectively.

Getting Started

Cloning the Repository

1. Clone the Repository

   Clone the main branch of the repository to your local machine:

   git clone -b main https://github.com/Whitewater-Research-Group/website.git

Setting Up the Project

1. Install Dependencies

   Install the required npm dependencies:

   npm install

2. Run the Development Server

   Start the development server using Vite:

   npm run dev

   This will start the Vite development server and open the project in your default browser. The app will automatically reload when you make changes to the code.

Making Changes

1. Create a New Branch

   Before making any changes, create a new branch from the main branch. This helps keep the main branch clean and makes it easier to manage feature development or bug fixes.

   git checkout -b your-branch-name

   Replace your-branch-name with a descriptive name for your branch.

2. Make Your Changes

   Work on the project as needed. Ensure that you follow the project's coding standards and best practices.

3. Commit Your Changes

   After making changes, commit them to your branch:

   git add .
   git commit -m "Description of your changes"

4. Push Your Changes

   Push your branch to the remote repository:

   git push origin your-branch-name

Pull Requests

• Create a Pull Request (PR)

  Once you’ve pushed your changes, create a pull request from your branch to the main branch on the repository. This will allow others to review and merge your changes.

Additional Information

• Project Documentation

  Refer to the project’s architecture for detailed information on project structure, development guidelines, and other relevant details.