Contributing to ChatSharing

Thank you for considering contributing to this project! 🎉
Here are the guidelines and setup instructions to help you get started.

🛠 Local Development Setup

Follow these steps to run the project locally:

1. Clone the Repository

git clone https://github.com/yasir13001/ChatSharing.git
cd ChatSharing

2. Install Ruby and Bundler

Ensure Ruby (>= 3.0) and Bundler are installed. If not:

Install Ruby: https://www.ruby-lang.org/en/documentation/installation/
Install Bundler:

gem install bundler

3. Install Project Dependencies

bundle install

4. Serve the Jekyll Site

bundle exec jekyll serve

This will start the server at http://localhost:4000.

🐳 Running the Project with Docker

If you’d prefer not to set up the project locally with Ruby and dependencies, you can use Docker to build and run the project in a containerized environment.

📦 Build the Docker Image

docker build -t chatsharing .

This will create a Docker image named chatsharing using the provided Dockerfile.

🚀 Run the Container

docker run -p 4000:4000 chatsharing

This maps the container’s port 4000 to your local machine’s port 4000 so you can access the app via http://localhost:4000.

✅ Use Docker Volume to Reflect Real-Time Changes

To build and run a Docker image that reflects real-time changes from your working directory (i.e. live development), you don’t need to rebuild the image every time you change code. Instead, use Docker volumes to mount your local directory inside the container.

Linux/macOS:

docker run -v "$PWD":/app -w /app -p 4000:4000 --name chatsharing-dev chatsharing jekyll serve --host 0.0.0.0

Windows CMD:

docker run -v %cd%:/app -w /app -p 4000:4000 --name chatsharing-dev chatsharing jekyll serve --host 0.0.0.0

Windows PowerShell:

docker run -v ${PWD}:/app -w /app -p 4000:4000 --name chatsharing-dev chatsharing jekyll serve --host 0.0.0.0

🔧 Notes:

You can now stop it with:
```
docker stop chatsharing-dev
```
And start it again with:
```
docker start -a chatsharing-dev
```

🔍 Explanation:

Flag	Description
`--name chatsharing-dev`	Names your container so you can easily stop/start it later.
`-v "$PWD":/app`	Mounts your current directory to `/app` in the container
`-w /app`	Sets the working directory inside the container
`-p 4000:4000`	Maps container’s port 4000 to host’s port 4000
`jekyll serve --host 0.0.0.0`	Starts Jekyll server listening for external requests

🚀 Benefits

No need to rebuild the image on every change.
You edit files locally, and the container uses them immediately.
Ideal for development.

🚧 Contributing via Issues

Check the Issues tab for open issues.
Comment on the issue you’d like to work on and ask to be assigned.
Fork the repository and make your changes in a separate branch.
Create a pull request once your changes are ready.
Don’t forget to update the README.md or relevant documentation.

🧪 Testing Your Changes

Make sure your changes don’t break the existing site.
Style updates should be visible and functional.
Check the developer console for errors.
Always update README.md if your changes introduce or modify functionality.

🔄 Git Workflow

Fork the repository.
Create a new branch:
```
git checkout -b your-feature-name
```

Make your changes and commit them:

git commit -m "Add feature: [your feature here]"

Push to your fork:
```
git push origin your-feature-name
```
Open a Pull Request to the main branch.

📄 Additional Notes

Please rebase if the main branch has moved ahead.
Follow semantic commit messages if possible.
For major UI changes, consider including screenshots.

Thanks again for contributing! 🙌