-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
46 changed files
with
1,161 additions
and
586 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Code of Conduct | ||
|
|
||
| As members of the KEC Computer Club community, we are dedicated to creating a welcoming, inclusive, and respectful environment for everyone, regardless of background, experience, or identity. This Code of Conduct applies to all interactions in our repository, Discord server, events, and other spaces where our community gathers. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| We strive to: | ||
| - **Be welcoming and respectful.** Treat others with kindness and empathy. Appreciate diverse perspectives and experiences. | ||
| - **Engage in constructive discussions.** Provide helpful feedback and encourage learning by supporting each other. | ||
| - **Stay focused and collaborative.** Work towards the goals of the KEC Computer Club. Respect others' time by being constructive and on-topic. | ||
| - **Respect personal boundaries.** Avoid inappropriate language or behavior and respect others' comfort levels in all interactions. | ||
|
|
||
| ## Unacceptable Behavior | ||
|
|
||
| Examples of unacceptable behavior include: | ||
| - Harassment, discrimination, or derogatory comments based on race, gender, sexual orientation, disability, or any other personal characteristic. | ||
| - Insults, threats, or personal attacks. | ||
| - Excessive promotion of unrelated content, spamming, or off-topic discussions. | ||
| - Disruptive behavior, trolling, or intentional intimidation. | ||
|
|
||
| ## Reporting and Enforcement | ||
|
|
||
| If you experience or witness any behavior that violates this Code of Conduct, please report it to our team: | ||
| - **Email:** [computerclub@kec.edu.np](mailto:computerclub@kec.edu.np) | ||
| - **Discord Moderator Contact:** Message any moderator or admin on the [Discord server](https://discord.gg/neMkXj7GC3). | ||
|
|
||
| All reports will be handled confidentially, and appropriate action will be taken to maintain a safe and welcoming community. | ||
|
|
||
| ## Consequences | ||
|
|
||
| Violations of the Code of Conduct may result in: | ||
| - A warning for minor issues. | ||
| - Temporary or permanent suspension from participation in the repository, Discord server, or KEC Computer Club events. | ||
| - Permanent ban from the community for severe or repeated offenses. | ||
|
|
||
| By participating in the KEC Computer Club, you agree to uphold this Code of Conduct. Let's create a positive and productive community for everyone. | ||
|
|
||
| --- | ||
|
|
||
| *This Code of Conduct is adapted and inspired by community standards outlined in the [Contributor Covenant](https://www.contributor-covenant.org/).* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # MIT License | ||
|
|
||
| Copyright (c) 2024 KEC Computer Club, Kantipur Engineering College | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,170 @@ | ||
| <div align="center"> | ||
| <a href="https://kec.edu.np/"> | ||
| <img alt="KEC Computer Club" src="assets/images/horizontaldisplaypicture.png" width="350"> | ||
| </a> | ||
|
|
||
| # 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. | ||
| [](https://computerclubkec.github.io) | ||
| [](https://github.com/computerclubkec/computerclubkec.github.io/graphs/contributors) | ||
| [](https://discord.gg/neMkXj7GC3) | ||
| [](https://opensource.org/licenses/MIT) | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
| <a href="https://computerclubkec.github.io/">Home</a> | | ||
| <a href="https://computerclubkec.github.io/about/">About Us</a> | | ||
| <a href="https://computerclubkec.github.io/blog/">Blog</a> | | ||
| <a href="https://computerclubkec.github.io/projects/">Projects</a> | | ||
| <a href="https://linktr.ee/computerclubkec">Linktree</a> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
| <strong>The official website repository for the KEC Computer Club.</strong><br> | ||
| Our website provides updates on club events, resources, projects, and technical content for students of Kantipur Engineering College and beyond. | ||
| </div> | ||
|
|
||
| ## 📋 Table of Contents | ||
| - [About](#about-kec-computer-club) | ||
| - [Features](#features) | ||
| - [Project Structure](#project-structure) | ||
| - [Getting Started](#getting-started) | ||
| - [Development](#development) | ||
| - [Contributing](#contributing) | ||
| - [Community](#community) | ||
| - [Development Sessions](#development-sessions) | ||
| - [Contact](#contact) | ||
|
|
||
| ## 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. | ||
| Founded in 2013 at **Kantipur Engineering College (KEC)**, the Computer Club is a student-driven organization that promotes tech learning, collaboration, and project development. Our mission is to foster a vibrant tech community where students can learn, innovate, and grow together. | ||
|
|
||
| ## Features | ||
|
|
||
| - 🎯 Event updates and registration | ||
| - 📚 Technical resources and tutorials | ||
| - 💻 Project showcase | ||
| - 📝 Technical blog | ||
| - 📱 Responsive design | ||
| - 🌐 Cross-browser compatibility | ||
|
|
||
| ## 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. | ||
| ``` | ||
| computerclubkec.github.io/ | ||
| ├── _config.yml # Jekyll configuration | ||
| ├── _layouts/ # Page layouts | ||
| │ ├── default.html | ||
| │ ├── post.html | ||
| │ └── project.html | ||
| ├── _includes/ # Reusable components | ||
| │ ├── header.html | ||
| │ ├── footer.html | ||
| │ └── navigation.html | ||
| ├── _posts/ # Blog posts | ||
| ├── _projects/ # Project documentation | ||
| ├── assets/ # Static resources | ||
| │ ├── js/ # JavaScript files | ||
| │ └── images/ # Media files | ||
| ├── pages/ # Static pages | ||
| └── docker-compose.yml # Docker configuration | ||
| ``` | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Website Prototype | ||
| On the basis of [this Figma design](https://www.figma.com/design/dWPncZwMB3Im5qntztKgpe/Computer-Club-Website?node-id=0-1&t=snFpqhd7gHsoBQL7-1), the club website is planned to be developed. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| To work on this project, ensure you have the following installed: | ||
| - [Docker](https://www.docker.com/) (recommended): For containerizing and deploying applications, making development and deployment more consistent and portable. | ||
| - [Jekyll](https://jekyllrb.com/): Static site generator that converts markdown and other formats into static HTML websites, simplifying web development. | ||
| - [Git](https://git-scm.com/): Distributed version control system for tracking changes in source code during development. | ||
| - [Tailwind CSS](https://tailwindcss.com/): Utility-first CSS framework that allows rapid custom design by composing utility classes directly in HTML. | ||
|
|
||
| ### Design Prototype | ||
|
|
||
| The website is being developed based on [this Figma design](https://www.figma.com/design/dWPncZwMB3Im5qntztKgpe/Computer-Club-Website?node-id=0-1&t=snFpqhd7gHsoBQL7-1). | ||
|
|
||
| - [Docker](https://www.docker.com/) (for running the site locally in a container) | ||
| - [Jekyll](https://jekyllrb.com/) (for building and serving the site) | ||
| - [Git](https://git-scm.com/) (for version control) | ||
| - [Tailwind CSS](https://tailwindcss.com/) (for utility-first CSS framework) | ||
| ## Development | ||
|
|
||
| ### Running the Project Locally with Docker | ||
| ### Using Docker (Recommended) | ||
|
|
||
| 1. Clone the repository: | ||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/computerclubkec/computerclubkec.github.io.git | ||
| ``` | ||
|
|
||
| 2. Navigate to the project directory: | ||
| ```bash | ||
| cd path_to_your_folder | ||
|
|
||
| # Navigate to project directory | ||
| cd computerclubkec.github.io | ||
|
|
||
| # Start the development server | ||
| docker-compose up | ||
|
|
||
| # Access the site at http://localhost:4000 | ||
| ``` | ||
|
|
||
| 3. Build and run the Docker container: | ||
| ### Without Docker | ||
|
|
||
| ```bash | ||
| docker compose up | ||
| # Install dependencies | ||
| bundle install | ||
| npm install | ||
|
|
||
| # Start the development server | ||
| bundle exec jekyll serve | ||
|
|
||
| # In a separate terminal, watch for Tailwind CSS changes | ||
| npm run watch:css | ||
| ``` | ||
|
|
||
| 4. Access the website by navigating to _http://localhost:4000_ in your browser. | ||
| ## Contributing | ||
|
|
||
| ### Running Locally Without Docker | ||
| We welcome contributions from everyone! Please follow these steps: | ||
|
|
||
| If you prefer not to use Docker, you can run Jekyll directly: | ||
| 1. Fork the repository | ||
| 2. Create your feature branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
| 1. Install Jekyll and dependencies by following the official [Jekyll installation guide](https://jekyllrb.com/docs/installation/). | ||
| For detailed guidelines, please read our [CONTRIBUTING.md](CONTRIBUTING.md) and [NAMING-CONVENTION.md](NAMING-CONVENTION.md) files. | ||
|
|
||
| 2. Serve the website locally: | ||
| ```bash | ||
| jekyll serve | ||
| ``` | ||
| ## Community | ||
|
|
||
| ### Development Sessions | ||
|
|
||
| We host regular development sessions to: | ||
| - Review pull requests | ||
| - Discuss new features | ||
| - Debug issues | ||
| - Share knowledge | ||
| - Plan future improvements | ||
|
|
||
| 3. Visit the website at _http://localhost:4000_. | ||
| Join our [Discord Server](https://discord.gg/neMkXj7GC3) to participate in these sessions! | ||
|
|
||
| ### Contributing | ||
| Please refer to the [CONTRIBUTING.md](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. | ||
| ### Contributors | ||
|
|
||
| ### 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](NAMING-CONVENTION.md) document for more information. | ||
| Thanks to our dedicated contributors who continue to build and improve the KEC Computer Club's online presence: | ||
|
|
||
| ### Contributors | ||
| Thanks goes to these wonderful people who have contributed for the project: | ||
| <a href="https://github.com/computerclubkec/computerclubkec.github.io/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=computerclubkec/computerclubkec.github.io&max=400&columns=20" /> | ||
| </a> | ||
|
|
||
| [](https://github.com/computerclubkec/computerclubkec.github.io/graphs/contributors) | ||
| ### Code of Conduct | ||
|
|
||
| Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand our community standards and expectations. | ||
|
|
||
| ### Contact | ||
| For more information or to collaborate, feel free to reach out to us: | ||
| ## Contact | ||
|
|
||
| **Email:** _computerclub@kec.edu.np_ | ||
| - **Email:** [computerclub@kec.edu.np](mailto:computerclub@kec.edu.np) | ||
| - **Discord:** [Join our server](https://discord.gg/YOUR_INVITE_LINK) | ||
| - **Location:** Dhapakhel, Lalitpur, Nepal | ||
| - **Linktree:** [linktr.ee/computerclubkec](https://linktr.ee/computerclubkec) | ||
| - **Website:** [computerclubkec.github.io](https://computerclubkec.github.io) | ||
|
|
||
| **Linktree:** [linktr.ee/computerclubkec](https://linktr.ee/computerclubkec) | ||
| ## License | ||
|
|
||
| **Location:** Dhapakhel, Lalitpur | ||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
|
|
||
| Thank you for contributing to the KEC Computer Club's website! | ||
| --- | ||
|
|
||
| **KEC Computer Club** | ||
| <div align="center"> | ||
| Made with ❤️ by KEC Computer Club | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,11 @@ | ||
| html: devicon:html5 | ||
| # Arrange in alphabetical order | ||
|
|
||
| css: devicon:css3 | ||
| javascript: devicon:javascript | ||
| docker: devicon:docker | ||
| flutter: devicon:flutter | ||
| react: devicon:react | ||
| html: devicon:html5 | ||
| javascript: devicon:javascript | ||
| nodejs: devicon:nodejs | ||
| react: devicon:react | ||
| tailwindcss: devicon:tailwindcss | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.