Skip to content

ABES-CodeChef/CC-Website-5.O

Repository files navigation

CodeChef ABESEC Website

The official CodeChef ABESec club website is designed to showcase the events, activities, and achievements of our club. It features a clean and responsive design built with HTML, CSS, and JavaScript.

🚀 Deployed Project

You can explore the website directly by clicking the link below:

🔗 CodeChef ABESec Club Website

Table of Contents

Project Features

  • Responsive Design: Optimized for all devices (mobile, tablet, desktop).
  • Event Listings: Displays upcoming events and activities.
  • Team Page: Introduces the members of the CodeChef ABESec club.
  • Dynamic Blog: A space to showcase coding tutorials and other technical articles (planned). -more things are in process : some more cool thing will be added soon

installation

Follow these instructions to set up and run the project locally on your machine.

Prerequisites

Make sure you have the following installed on your system:

  • Git: To clone the repository. Download Git
  • Web Browser: Any modern web browser (e.g., Chrome,brave, Firefox, Edge)
  • Text Editor/IDE: Visual Studio Code, Sublime Text, etc.

⚙️ Steps to Run Locally

1. Clone the repository

Open a terminal and run the following command to clone the repository:

git clone https://github.com/your-username/your-repository.git

2. Now simpiely run the code with live server ..

Contributing

We welcome contributions from everyone! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated.

How to Contribute

  1. Fork the Repository
    Start by forking the project repository to your GitHub account.

  2. Clone Your Fork
    Clone your forked repository to your local machine: bash git clone https://github.com/yourusername/CC-Website-5.O.git

  3. Create a New Branch
    Create a new branch for your feature or bugfix: bash git checkout -b feature/my-new-feature

  4. Make Your Changes
    Implement your changes in the codebase. Ensure you follow coding standards and add clear, concise code.

  5. Commit Your Changes
    Commit your changes with a descriptive commit message following the Conventional Commits format: bash git commit -m "feat: add new blog section"

  6. Push Your Branch
    Push your changes to your forked repository: bash git push origin feature/my-new-feature

  7. Open a Pull Request
    Submit a pull request (PR) to the main branch of the original repository. Clearly describe your changes in the PR description and reference any related issues.

Commit Message Guidelines

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation changes
  • refactor: Code refactoring without adding features or fixing bugs

Tips for Writing Good Pull Requests

  • Keep your PR focused on one change.
  • Describe the problem your PR solves.
  • Reference any related issues in your PR description.
  • Ensure your code works and passes any existing tests.

TODO LIST

  • Finalize the Home page design
  • Ensure mobile responsiveness for all pages
  • Add About Us section
  • Implement Blog section for club update
  • final review by mentors

License

This project is licensed under the MIT License. See the LICENSE file for details.