/computerclubkec.github.io

This is the official website of KEC Computer Club.

Primary LanguageHTML

KEC Computer Club Website

Welcome to the official repository for the KEC Computer Club website! This website is built using Jekyll and containerized with Docker to streamline development and deployment.

About KEC Computer Club

The Computer Club of Kantipur Engineering College (KEC) was founded in 2013 to provide students with a platform to explore technology, develop new skills, and collaborate on innovative projects. Our website serves as a hub for club activities, events, and resources.

Project Structure

  • _config.yml: Jekyll configuration file.
  • index.html: The main homepage of the website.
  • _layouts/: Jekyll layout templates.
  • _includes/: Reusable components (e.g., headers, footers).
  • assets/: Contains images, stylesheets, and JavaScript files.
    • css/: Custom stylesheets.
    • js/: JavaScript files.
    • images/: Logos and visuals used on the website.

Getting Started

Website Prototype

On the basis of this Figma design, the club website is planned to be developed.

Prerequisites

To work on this project, ensure you have the following installed:

  • Docker (for running the site locally in a container)
  • Jekyll (for building and serving the site)
  • Git (for version control)
  • Tailwind CSS (for utility-first CSS framework)

Running the Project Locally with Docker

  1. Clone the repository:
git clone https://github.com/kec-computer-club/website.git
  1. Navigate to the project directory:
cd path_to_your_folder
  1. Build and run the Docker container:
docker compose up
  1. Access the website by navigating to http://localhost:4000 in your browser.

Running Locally Without Docker

If you prefer not to use Docker, you can run Jekyll directly:

  1. Install Jekyll and dependencies by following the official Jekyll installation guide.

  2. Serve the website locally:

jekyll serve
  1. Visit the website at http://localhost:4000.

Contributing

Please refer to the CONTRIBUTING.md file for detailed instructions on how to contribute to this project. It outlines the workflow for making changes, submitting pull requests, and reviewing contributions.

File Conventions

To maintain code consistency and best practices, we follow specific conventions for structuring files and code. Please refer to the NAMING-CONVENTION.md document for more information.

Contributors

Thanks goes to these wonderful people who have contributed for the project:

Contributors

Contact

For more information or to collaborate, feel free to reach out to us:

Email: computerclub@kec.edu.np

Linktree: linktr.ee/computerclubkec

Location: Dhapakhel, Lalitpur

Thank you for contributing to the KEC Computer Club's website!

KEC Computer Club